Настройте уведомление о лимите для тарифного плана

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Вы можете уведомить разработчиков по электронной почте, когда они приближаются или достигают определенного предела тарифного плана Volume Banded или Bundle, который они приобрели. Например, если разработчики приобретают тарифный план с 1000 вызовами в пакете, вы можете уведомить их, когда они достигнут 800 вызовов (использование 80 %) или когда они потратят 500 долларов США на вызовы API.

Чтобы настроить уведомление о лимите для тарифного плана с помощью API, выполните следующие действия:

  1. Настройте шаблон уведомления , который будет использоваться для уведомления разработчика.
  2. Настройте условие и действие уведомления .

Настройка шаблона уведомления

Ниже приведен пример настройки шаблона уведомления, который будет использоваться для уведомления разработчика. Дополнительную информацию см. в разделе Управление шаблонами уведомлений с помощью 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

Настройка условия и действия уведомления

Настройте условие и действие уведомления с помощью API, как описано в разделе Настройка условий и действий уведомления с помощью API .

Чтобы вызвать уведомление об лимите тарифного плана, установите следующие атрибуты:

  • RATEPLAN — тип отправляемого уведомления.
  • PUBLISHED – установите для этого атрибута значение TRUE, чтобы активировать уведомления об опубликованных тарифных планах.

Затем укажите один из следующих атрибутов:

  • Transactions — количество транзакций. Например, уведомить разработчиков, когда они достигнут 800 транзакций. Должно быть целочисленным значением. Разрешены только операторы > и =.
  • FeeExposure — количество долларов или баллов, накопленных по транзакциям. Должно быть целочисленным значением. Разрешены только операторы > и =. FeeExposure не включает суммы платы за установку, периодическую плату или плату за прекращение действия. Например, уведомите разработчиков, когда стоимость их транзакций API достигнет 500 долларов США. Расчеты FeeExposure варьируются в зависимости от ставки налога.

Следующая полезная нагрузка запускает уведомление по электронной почте, когда количество транзакций достигает 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