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

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

Você pode notificar os desenvolvedores por e-mail quando eles estiverem se aproximando de um determinado limite de um plano de tabela de preços por volume ou pacote adquirido. Por exemplo, se os desenvolvedores comprar um plano de volume banda com 1.000 chamadas em um pacote, você pode notificá-los quando eles entrarem em contato 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 tarifas 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.

Personalizar o modelo de notificação

Confira abaixo um exemplo de como personalizar o modelo de notificação que será usada 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 de notificação

Configure uma condição e uma ação de notificaçã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 de um limite de plano de tarifas, defina os seguintes atributos:

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

Em seguida, especifique um dos seguintes atributos:

• Transactions: número de transações. Por exemplo, notificar os desenvolvedores quando até 800 transações. Precisa ser um valor inteiro e somente maior que e = são permitido.
• FeeExposure: valor em dólares ou pontos acumulados nas transações. Deve ser um valor inteiro e somente > e = são permitidos. FeeExposure não inclui valores de taxa de configuração, recorrentes ou rescisão. Por exemplo, notificar os desenvolvedores quando o custo das transações da API atingir US $500. FeeExposure de cálculos 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 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