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

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

Você pode notificar os desenvolvedores por e-mail quando eles estiverem se aproximando ou tiverem atingido um determinado limite de um plano de taxas de faixa de volume ou de 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 taxas 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 de notificação.

Personalizar o modelo de notificação

A seguir, apresentamos 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

Configurar a condição e a ação de notificação

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

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

• RATEPLAN - Tipo de notificação a ser enviada.
• PUBLISHED - Defina esse atributo como TRUE para acionar notificações em planos de taxas publicados.

Em seguida, especifique um dos seguintes atributos:

• Transactions - Número de transações. Por exemplo, notifique os desenvolvedores quando eles atingirem 800 transações. Precisa ser um valor inteiro, e somente os operadores > e = são permitidos.
• FeeExposure - Valor de dólares ou pontos acumulados em transações. Precisa ser um valor inteiro, e somente os operadores > e = são permitidos. FeeExposure não inclui valores de taxas de configuração, recorrentes ou de rescisão. Por exemplo, notifique os desenvolvedores quando o custo das transações de API atingir US $500. FeeExposure cálculos variam dependendo da taxa de imposto.

O payload a seguir aciona uma notificação por e-mail quando o número de transações atinge 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