Configurar uma notificação de limite para um plano de tarifas

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

É possível notificar os desenvolvedores por e-mail quando eles estiverem se aproximando ou tiverem atingido um determinado limite de um plano de tabela de preços com bandas por volume ou pacote que compraram. Por exemplo, se os desenvolvedores comprarem um plano de faixa de volume com 1.000 chamadas em um pacote, você poderá notificá-los quando atingirem 800 chamadas (80% de uso) ou quando gastarem US $500 em chamadas de API.

Para configurar uma notificação de limite para um plano de tarifa usando a API, siga estas etapas:

1. Personalize o modelo de notificação que será usado para notificar o desenvolvedor.
2. Configure a condição e a ação da notificação.

Como personalizar o modelo de notificação

Confira a seguir um exemplo de como personalizar o modelo de notificação que será usado para notificar o desenvolvedor. Para mais informações, consulte Como gerenciar modelos de notificação usando a API.

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

Como configurar a condição e a ação da notificação

Configure uma condição de notificação e uma ação usando a API, conforme descrito em Como configurar condições e ações de notificação usando a API.

Para acionar a notificação sobre um limite de plano de tarifa, defina os seguintes atributos:

• RATEPLAN: tipo de notificação a ser enviada.
• PUBLISHED: defina esse atributo como TRUE para acionar notificações sobre planos de tarifas publicados.

Em seguida, especifique um dos seguintes atributos:

• Transactions: número de transações. Por exemplo, notifique os desenvolvedores quando eles alcançarem 800 transações. Precisa ser um valor inteiro, e apenas os operadores > e = são permitidos.
• FeeExposure: valor de dólares ou pontos acumulados nas transações. Precisa ser um valor inteiro, e apenas os operadores > e = são permitidos. FeeExposure não inclui valores de taxa de configuração, recorrente ou rescisão. Por exemplo, notifique os desenvolvedores quando o custo das transações de API atingir US $500. Os cálculos de FeeExposure variam de acordo com a alíquota.

O payload a seguir aciona uma notificação por e-mail quando o número de transações chega a 800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password