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

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

Введение

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

Настройка гибкого плана уведомлений с помощью пользовательского интерфейса.

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

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

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

Для задания настраиваемого плана уведомлений укажите следующие значения в параметре ratePlanDetails тела запроса:

Для получения дополнительной информации о параметрах конфигурации, которые можно задать при указании параметров настраиваемого плана уведомлений, см. раздел «Параметры конфигурации параметров тарифного плана» .

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

$ 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