Configurar notificações de limite

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

É possível definir limites relacionados à monetização, conforme descrito em Aplicar limites de monetização usando a política de verificação de limites de monetização. Também é possível configurar notificações automáticas que alertam os desenvolvedores, e/ou usuários da sua organização quando um limite está se aproximando ou é atingido.

É possível configurar notificações automáticas para limites personalizados e implícitos. Por exemplo, o sistema define um limite implícito para seus desenvolvedores pré-pagos, que é o saldo pré-pago deles. É possível configurar notificações automáticas para que os desenvolvedores sejam notificados se estiverem se aproximando ou tiverem atingido o saldo pré-pago.

Caixa de ferramentas

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

Se você usar a API, configure as notificações automáticas para limites editando um modelo de notificação fornecido pela monetização. Em seguida, especifique a condição que resulta no envio da 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". Isso abre a seção "Notificação" .

   

2. Selecione um nível para a notificação. Esse é um limite com base em um número absoluto ou em uma porcentagem da base de limite. Selecione:
   • O sinal de maior ou igual a (?) ou o sinal de menor ou igual a (?) 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 percentuais, sempre defina o limite como >, o que significa que a notificação será enviada quando o desenvolvedor atingir ou ultrapassar esse nível percentual.

   Por exemplo, se você definir um limite de gastos de US $100 e definir a notificação como maior 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 um ou mais usuários na sua organização. A notificação será enviada aos desenvolvedores ou usuários afetados.

   Destinatários de e-mail:só é possível enviar notificações aos desenvolvedores se você definir uma condição de limite de desenvolvedor "Qualquer" ou definir uma condição de limite de desenvolvedor com um desenvolvedor específico. Se você selecionar "Qualquer", verá "Desenvolvedor selecionado (qualquer)" na lista de endereços de e-mail. Isso significa que a monetização enviará uma notificação a todos os desenvolvedores afetados. Se você selecionar um desenvolvedor específico, verá "Desenvolvedor selecionado ({developer_id})" na lista de endereços de e-mail (em que {developer_id} é a identificação do desenvolvedor selecionado). A monetização enviará uma notificação apenas para esse desenvolvedor específico.

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

   É possível adicionar endereços de e-mail para os usuários da sua organização selecionando "Usuários da organização" na guia "Administrador".

   Modelos de e-mail: você verá um modelo de e-mail depois de selecionar no campo "Enviar e-mail" "Desenvolvedor selecionado (qualquer)" ou endereços de e-mail de usuários na sua 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 era 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 o mesmo valor do limite.
   • O e-mail é apenas para usuários da organização.

   O modelo é assim:

   

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

   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 para "Desenvolvedor selecionado (qualquer)", o modelo vai aparecer da seguinte maneira:

   

   Os dois modelos vão resolver as variáveis relevantes, como nome do desenvolvedor (se aplicável), nome do pacote (se aplicável) e nome do produto (se aplicável). É possível editar a mensagem para atender aos seus requisitos clicando em "Editar" à esquerda do modelo.

   Se o limite for para "Qualquer" ou um aplicativo específico e "Qualquer" ou um usuário específico, também será necessário adicionar variáveis para os aplicativos e usuários ao modelo. É possível fazer isso da seguinte maneira:

   • 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 é mostrado abaixo.

   

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

   

   Novamente, se o limite for para "Qualquer" (ou um específico) aplicativo ou "Qualquer" (ou um específico) usuário, será necessário editar o modelo e adicionar o aplicativo ${application.name} e/ou o 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 seguintes variáveis.

   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 de API.
   ${application.name}	O nome do aplicativo.
   ${USER}	O nome do usuário.
   ${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 de taxas).
   ${QUOTA_UNIT}	A unidade básica para o limite: moeda (para um limite de gastos) ou chamadas (para um limite de transações).
   ${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 um desenvolvedor atingir uma determinada porcentagem do volume de transações de qualquer pacote em qualquer aplicativo, edite o modelo para que ele 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 nível, "Enviar e-mail" e "Modelo de e-mail" à seção "Notificações" da página. É possível adicionar até seis níveis para suas notificações. Por exemplo, se você definir a notificação como > 70%, 80%, 90%, 100%, uma notificação será enviada quando cada um desses níveis for atingido.
5. Depois de adicionar todas as notificações, clique em "Salvar" (para salvar e publicar as notificações em uma data posterior), "Salvar e publicar" (para publicar agora) ou "Cancelar" (para cancelar).

Como configurar notificações de limite usando a API

A monetização oferece um conjunto de modelos que fornecem o texto para vários tipos de notificações, incluindo notificações de limite e notificações ad hoc, como alertar os desenvolvedores sobre a disponibilidade de novos produtos. É possível personalizar qualquer um desses modelos para atender às suas necessidades. Para configurar uma notificação de limite automática, primeiro edite um modelo apropriado. Em seguida, 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 novos produtos, novas versões dos Termos e Condições ou novos planos de tarifas. Consulte Configurar notificações usando modelos de notificação.