配置可调整的通知计划

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

简介

在可调整的通知方案中，API 提供方可以为每个应用开发者调整目标交易次数。您可以根据何时达到目标数量的百分比（例如 90%、100% 或 150%）来配置是否以及何时发送通知。达到目标数量后，其他交易不会被阻止。

使用界面配置可调整的通知计划

如下所述，配置可调整的通知计划。

使用 API 配置可调整的通知计划

在对 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 的 POST 请求的请求正文的 ratePlanDetails 属性中指定可调整的通知计划详细信息。

如需指定可调整的通知方案，请在请求正文的 ratePlanDetails 中指定以下值：

媒体资源	值
type	设置为 USAGE_TARGET。
meteringType	设置为 DEV_SPECIFIC。
duration	设置为汇总基础的时间段，以及 durationType。对于可调整的通知费率方案，请将此字段设置为 1 到 24 之间的整数值。
durationType	设置为汇总基础的时间段，以及 durationType。对于可调整的通知费率方案，请将此值设置为 MONTH。

如需详细了解在指定可调整的通知方案详细信息时可以设置哪些配置属性，请参阅费率方案详细信息的配置设置。

例如，以下代码定义了一个汇总依据设置为 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 的每位应用开发者设置目标交易次数

您可以为应用开发者设置在开发者接受此费率方案时的目标交易次数，然后您可以稍后更新该值。

在接受费率方案时设置目标交易次数

在接受费率方案时，如需设置目标交易次数，请在针对 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 资源的 POST 请求的请求正文中指定 quotaTarget 属性。 将 quotaTarget 设置为正整数或 0 以停用应用开发者的通知功能。如果未指定，则 quotaTarget 默认为 0。

例如，当应用开发者接受可调整的通知方案时，以下请求会将目标交易次数设置为 4, 000 次。

$ 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

在更新接受的费率方案时设置目标交易次数

如需设置目标交易数量，您可以更新接受的费率方案，并在对 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 资源的 PUT 请求的请求正文中指定 quotaTarget 属性。将 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
}

或者，您也可以通过向 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans 发出 GET 请求来获取开发者费率方案的 {developer-rateplan-id}，其中 {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 
}
        

以下请求将目标事务数更新为 4,000。

$ curl -H "Content-Type:application/json" -X PUT1 PUT1 PUT -d \
'semail:password