Configurar notificações de limite

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Introdução

É possível definir limites relacionados à monetização, conforme descrito em Como aplicar limites de monetização usando a política de verificação dos limites de monetização. Também é possível configurar notificações automáticas para alertar os 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. Por exemplo, o sistema define um limite implícito para seus desenvolvedores pré-pagos, que é o saldo pré-pago. É possível configurar notificações automáticas para que seus desenvolvedores sejam avisados se estiverem se aproximando do saldo pré-pago ou tiverem alcançado o limite.

Caixa de ferramentas

Você pode configurar notificações automáticas de limites usando a interface de gerenciamento ou a API de monetização. Se você usa a interface, pode configurar notificações automáticas na página "Notificações".

Se você usa a API, pode configurar 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 baseado em um número absoluto ou uma porcentagem do limite. Selecione:
    • O sinal de maior ou igual (?) ou 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 de porcentagem, defina-o como >. Isso significa que a notificação será enviada quando o desenvolvedor atingir ou ultrapassar esse nível de porcentagem.

    Por exemplo, se você definir um limite de gasto de US $100 e definir a notificação como maior ou igual a 90%, ela 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 da sua organização. Os desenvolvedores ou usuários afetados vão receber uma notificação.

    Destinatários do e-mail: só será possível enviar notificações aos desenvolvedores se você definir uma condição de limite do desenvolvedor como "Qualquer" ou uma condição de limite do desenvolvedor com um desenvolvedor específico. Se você selecionou "Qualquer", vai aparecer "Desenvolvedor selecionado (qualquer)" na lista de endereços de e-mail. Isso significa que a monetização enviará uma notificação para todos os desenvolvedores afetados. Se você selecionou um desenvolvedor específico, vai encontrar "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 vai enviar uma notificação apenas para esse desenvolvedor.

    Se você não tiver selecionado uma condição de limite do desenvolvedor "Qualquer" ou um desenvolvedor específico, não vai encontrar "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 "Usuários da organização" na guia "Administrador".

    Modelos de e-mail: você verá um modelo de e-mail depois de selecionar no campo "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 interrupção de execução.
    • Indica se o e-mail foi enviado por 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 é de 100% ou o mesmo valor do limite.
    • O e-mail é apenas para usuários da organização.

    O modelo é semelhante a este:

    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 "Y Product". A data de validade é 30 de setembro de 2013. A mensagem de e-mail enviada seria 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á assim:

    Os dois modelos resolverão as variáveis relevantes, como o nome do desenvolvedor (se aplicável), o nome do pacote (se aplicável) e o nome do produto (se aplicável). Para atender aos seus requisitos, edite a mensagem 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, você também precisará adicionar variáveis para os aplicativos e usuários ao modelo. Você pode 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 para um aplicativo específico é mostrado abaixo.

    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 vai ficar assim:

    Novamente, se o limite for para um aplicativo "Qualquer" (ou específico) ou "Qualquer" (ou um usuário específico), 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 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 total 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 taxa).
    ${QUOTA_UNIT}

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

    O valor do limite.
    ${EXPIRY_DATE}

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

    Por exemplo, se você quiser receber uma notificação quando algum desenvolvedor atingir uma determinada porcentagem do volume de transações para 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 aumentar os níveis. Para cada nível adicional, clique em "Adicionar". Isso adiciona as áreas "Nível", "Enviar e-mail" e "Modelo de e-mail" à seção "Notificações" da página. Você pode adicionar até seis níveis às notificações. Por exemplo, se você definir a notificação como > 70%, 80%, 90% ou 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 fornece um conjunto de modelos que fornece o texto para vários tipos de notificações, incluindo notificações de limite, bem como notificações ad hoc, como alerta os 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. 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.