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

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

Введение

В настраиваемом плане уведомлений поставщик 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