Configurar notificações de limite

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Introdução

Você pode definir limites relacionados à monetização, conforme descrito em Aplicação de limites de monetização usando o Política de verificação de limites. Também é possível configurar notificações automáticas que alertam desenvolvedores, e/ou usuários na sua organização quando um limite estiver se aproximando ou for atingido.

Você pode configurar notificações automáticas para limites personalizados e implícitos. Para exemplo, o sistema define um limite implícito para seus desenvolvedores pré-pagos, que é o limite equilíbrio. É possível configurar notificações automáticas para que seus desenvolvedores sejam avisados se forem estão se aproximando ou atingiram seu saldo pré-pago.

Caixa de ferramentas

É possível configurar notificações automáticas sobre limites usando a interface de gerenciamento ou a API de monetização. Se você usa a IU, pode configurar as notificações automáticas na página "Notificações".

Se você usa a API, edite uma notificação para configurar notificações automáticas dos limites modelo fornecido pela monetização. Depois, você especifica a condição que resulta no envio do notificação fornecida pelo modelo editado.

Como configurar notificações de limite usando a interface

  1. Clique em Adicionar na seção Notificações da página Adicionar limite. Essa ação abre a notificação nesta seção.

  2. Selecione um nível para a notificação. Esse limite é baseado em um número absoluto ou a porcentagem da base do limite. Selecionar:
    • O sinal de maior ou igual (?) ou de menor ou igual a (?) da no menu suspenso.
    • Um número inteiro (ou seja, sem casas decimais). Absoluto (para indicar um valor numérico) ou Porcentagem para indicar um valor percentual. Para limites de porcentagem, sempre defina o como >, o que significa que a notificação é enviada quando o desenvolvedor atinge ou ultrapassar esse nível percentual.

    Por exemplo, se você definir um limite de gasto de US $100 e configurar uma notificação para um valor maior do que ou igual a 90%, a notificação será enviada quando 90% do limite (US$ 90) for atingido ou excedido.

  3. No campo Enviar e-mail , selecione um ou mais desenvolvedores ou selecione um ou mais usuários na sua organização. Uma notificação será enviada aos desenvolvedores ou usuários afetados.

    Destinatários do e-mail:só será possível enviar notificações para desenvolvedores se você definir uma Condição de limite do desenvolvedor "Qualquer" ou defina uma condição de limite do desenvolvedor desenvolvedor. Se você tiver selecionado "Qualquer", a mensagem "Desenvolvedor selecionado (qualquer)" vai aparecer. na lista de endereços de e-mail. Isso significa que a monetização enviará uma notificação a todas as pessoas afetadas desenvolvedores de aplicativos. Caso tenha selecionado um desenvolvedor específico, será exibida a mensagem "Desenvolvedor selecionado ({developer_id})" na lista de endereços de e-mail (em que {developer_id} é a identificação do desenvolvedor selecionado. Monetização enviará uma notificação somente para esse desenvolvedor específico.

    Se você não tiver selecionado a condição de limite do desenvolvedor "Qualquer" ou um desenvolvedor específico, não vai aparecer a mensagem "Desenvolvedor selecionado (qualquer)" no campo "Enviar e-mail". No entanto, é possível escolher quais usuários da organização você quer notificar.

    Para adicionar endereços de e-mail para os usuários da sua organização, selecione "Organização" Usuários na guia "Administrador".

    Modelos de e-mail:você vai encontrar um modelo de e-mail depois de selecionar na caixa de seleção campo "Desenvolvedor selecionado (qualquer)" ou endereços de e-mail de usuários da organização (ou ambos).O que aparece no modelo depende do seguinte:

    • O nível da notificação.
    • Se o limite era ou não um limite de execução de interrupção.
    • Se o e-mail foi enviado para usuários da organização, desenvolvedores ou ambos.

    Por exemplo, se todas as condições a seguir forem verdadeiras:

    • A caixa de seleção "Interromper execução" está marcada.
    • O nível de notificação é 100% ou igual ao limite.
    • O e-mail é apenas para usuários da organização.

    O modelo tem esta aparência:

    Suponha que o nome da empresa do desenvolvedor seja "empresa XYZ", o volume de transações é definido como 50 para um pacote de API chamado "Pacote X" e um produto de API chamado "Produto Y", e a data de validade é 30 de setembro de 2013. A mensagem de e-mail enviada fica assim:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    Se o e-mail for "Desenvolvedor selecionado (qualquer)", o modelo aparecerá da seguinte forma:

    Ambos os modelos resolverão as variáveis relevantes, como nome do desenvolvedor (se aplicável), nome do pacote (se aplicável) e nome do produto (se aplicável). Você pode editar a mensagem para atendam aos seus requisitos clicando em Editar à esquerda do modelo.

    Se o limite for "Qualquer" ou um aplicativo específico e em "Qualquer um" ou um usuário específico, precisa adicionar variáveis para os aplicativos e usuários ao modelo. Você pode fazer isso como da seguinte forma:

    • Clique em Editar à esquerda do modelo.
    • Adicionar ${user.name} user, depending on whether the limit is for application and/or user.

    Um modelo editado para "Qualquer" ou um aplicativo específico.

    Se a opção Pausar execução não estiver marcada ou o nível de notificação for maior ou igual a 100%, o modelo de um desenvolvedor selecionado ficará assim:

    Novamente, se o limite for "Qualquer" (ou um aplicativo específico) ou "Qualquer" (ou uma específica) usuário, edite o modelo e adicione o aplicativo ${application.name} e/ou usuário ${user.name}, dependendo se o limite é para um aplicativo, um usuário ou ambos.

    Variáveis de modelo:ao editar a mensagem em um modelo de e-mail, é possível incluir qualquer uma das variáveis a seguir.

    Variável Descrição
    ${developer.name}

    O nome do desenvolvedor.
    ${developer.legalName}

    É o nome da empresa do desenvolvedor.
    ${ratePlan.monetizationPackage.displayName}

    O nome do pacote da API.
    ${application.name}

    O nome do aplicativo.
    ${USER}

    O nome do User.
    ${USAGE}

    Uso atual (receita ou cobranças totais ou volume).
    ${PERCENT}

    A porcentagem do limite atingido pelo uso atual.
    ${QUOTA_TYPE}

    O tipo de limite (volume de transações, limite de gastos ou exposição da taxa).
    ${QUOTA_UNIT}

    A unidade básica do limite: moeda (para um limite de gasto) ou chamadas (para um limite de gasto) (limite de transação).
    ${QUOTA_LIMIT}

    O valor do limite.
    ${EXPIRY_DATE}

    A data ou hora em que o limite expira ou quando ele é redefinido.

    Por exemplo, se você quiser ser notificado quando algum desenvolvedor chegar do volume de transações de qualquer pacote em qualquer aplicativo, é possível editar o modelo fique assim:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. Adicione notificações conforme necessário para outros níveis. Para cada nível adicional, clique em "Adicionar". Isso adiciona uma área de modelo Nível, Enviar e-mail e E-mail à seção Notificações do página. Você pode adicionar até seis níveis para as notificações. Por exemplo, se você definir notificação como > 70%, 80%, 90%, 100%, uma notificação será enviada quando cada um desses quando os níveis são atingidos.
  5. Depois de adicionar todas as notificações, clique em Salvar (para salvar e publicar as notificações em um mais tarde), Salvar e Publicar (para publicar agora) ou Cancelar (para cancelar). .

Como configurar notificações de limite usando a API

A monetização fornece um conjunto de modelos que fornecem o texto para vários tipos de notificações, incluindo notificações de limite, bem como notificações ad-hoc, como alertas desenvolvedores sobre a disponibilidade de novos produtos. Você pode personalizar qualquer um desses modelos para atender às suas necessidades. Para configurar uma notificação automática de limite, primeiro edite um modelo apropriado. Depois, especifique a condição que resulta no envio da notificação fornecida pelo modelo editado. Para mais detalhes, consulte Configurar notificações usando modelos de notificação.

Próximas etapas

Saiba como configurar notificações automáticas para alertar os desenvolvedores sobre eventos como como novos produtos, novas versões dos Termos e Condições ou novos planos de preços. Consulte Configurar notificações usando modelos de notificação.