Как настроить уведомление о достижении лимита для тарифного плана

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

Вы можете отправлять разработчикам уведомления по электронной почте, когда они приближаются к определенному лимиту или достигают его в рамках тарифного плана с пакетами или с учетом объема, который они приобрели. Например, если разработчики приобрели пакет на 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