Как настроить план уведомлений с возможностью корректировки

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

Введение

В плане с регулируемыми уведомлениями поставщик API может изменять целевое количество транзакций для каждого разработчика приложений. Вы можете настроить отправку уведомлений при достижении определенного процента от целевого числа, например 90%, 100 % или 150%. После достижения целевого числа дополнительные транзакции не блокируются.

Как настроить план уведомлений с возможностью корректировки в интерфейсе

Настройте планы уведомлений, как описано ниже.

Как настроить план уведомлений с помощью API

Укажите сведения о плане уведомлений с возможностью корректировки в свойстве ratePlanDetails в теле запроса POST к /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

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

Подробнее о настройках конфигурации для указания сведений о тарифном плане с регулируемыми уведомлениями…

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Установка целевого количества транзакций для каждого разработчика приложений, использующего API.

Вы можете задать целевое количество транзакций для разработчика приложения, когда он примет тарифный план, и изменить это значение позже.

Установка целевого количества транзакций при принятии тарифного плана

Чтобы задать целевое количество транзакций при принятии тарифного плана, укажите свойство quotaTarget в теле запроса POST к ресурсу /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Установите для параметра quotaTarget положительное целое число или 0, чтобы отключить уведомления для разработчика приложения. Если значение не указано, quotaTarget по умолчанию равно 0.

Например, следующий запрос устанавливает целевое количество транзакций на уровне 4000, если разработчик приложения примет план с регулируемыми уведомлениями.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Установка целевого количества транзакций при обновлении принятого тарифного плана

Чтобы задать целевое количество транзакций, обновите принятый тарифный план и укажите свойство quotaTarget в теле запроса PUT к ресурсу /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Установите для параметра quotaTarget положительное целое число или 0, чтобы отключить уведомления для разработчика приложения. Если значение не указано, quotaTarget по умолчанию равно 0.

Значение {developer_rateplan_id} возвращается в ответе, когда вы принимаете опубликованный тарифный план.

Пример:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Вы также можете получить {developer-rateplan-id} для тарифного плана с ценами для разработчиков, отправив GET-запрос на адрес /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, где {developer_id} – адрес электронной почты разработчика. Подробнее о том, как посмотреть все тарифные планы, принятые разработчиком…

Пример:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

В приведенном ниже запросе целевое количество транзакций изменяется на 4000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password