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

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

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