配置可调整的通知计划

您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 info

简介

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

使用界面配置可调整的通知方案

按照以下说明配置可调整的通知方案。

Edge

如需使用 Edge 界面配置可调整的通知方案，请在添加或修改费率 方案时选择可调整的通知费率方案类型，然后在可调整的通知部分中配置以下信息：

字段 说明 默认
计算频率 计算交易量（或与自定义属性相关的量）的时间段。选择月数（1-24 个月）。 1 个月

如果您为 API 产品定义了自定义属性，则可以配置自定义评级参数，以根据自定义属性定义交易计数器。

例如，您可能需要：

  • 根据 API 调用消息中提供的值向开发者收取可变金额。
    例如，您可能希望根据 API 请求中传输的字节数向应用开发者收费。
  • 将多个 API 调用捆绑到单个交易中。
    在这种情况下，请选择“使用自定义评级参数”，然后从下拉列表中选择自定义属性。

如需了解详情，请参阅使用自定义属性配置费率方案。

Classic Edge（私有云）

如需使用 Classic Edge 界面配置可调整的通知方案，请执行以下操作：

  1. 在“费率方案”窗口的“方案详情”标签页中，选择费率方案类型 字段中的可调整的通知。

    如需了解如何访问“费率方案”窗口，请参阅使用界面创建费率方案 。

  2. 将续订期限 字段设置为方案 自动续订的月数（除非开发者在该日期之前终止协议）。如果您将此值设置为 0，则方案将一直有效，直到开发者选择结束该方案为止。
  3. 点击“通用费率方案”下的详细信息 。
  4. 将汇总依据 设置为汇总交易量的时间段。选择介于 1 到 24 个月之间的数字。此值默认为 1 个月。
  5. 点击 Apply and Close 。
  6. 点击保存草稿 。
  7. 只有在您完全确定方案是最终方案时，才发布该方案。如需了解如何设置“发布日期”和发布方案，请参阅发布费率方案。

    发布费率方案后，您只能修改结束日期。发布费率 方案后，您无法删除该方案，但可以使该方案过期并将其替换为未来的费率 方案，如使已发布的费率 方案过期中所述。

使用 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 为每个应用开发者设置目标 交易次数

对于接受了可调整的通知费率方案的每个应用开发者，您都需要 设置目标交易次数。您可以根据达到目标次数的百分比（例如 90%、100% 或 150%）的时间配置是否发送通知以及何时发送通知。 达到目标次数后，系统不会阻止额外的交易。

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

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

在接受费率方案时，如需设置目标交易次数，请在向 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 资源发出 POST 请求时，在请求正文中指定 quotaTarget 属性。 将 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

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

如需设置目标交易次数，您可以更新已接受的费率方案，并在向 /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 
}

以下请求会将目标交易次数更新为 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