<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
简介
在可调整的通知计划中,API 提供商可以调整 每笔应用开发者的交易量您可以配置是否以及何时发送通知 在达到目标百分比(如 90%、100%或 150%)时启用。其他 达到目标数量后,交易不会被屏蔽。
使用界面配置可调整的通知计划
配置可调整的通知计划,如下所述。
Edge
在添加或修改费率时,使用 Edge 界面配置可调整的通知计划 方案选择可调整通知费率方案类型,然后在可调整通知部分配置以下信息:
字段 | 说明 | 默认 |
---|---|---|
计算频率 | 计算交易量(或自定义属性相关量)的时间段。选择月份数(1-24 个月)。 | 1 个月 |
如果您为自己的 API 产品定义了自定义属性,则可以配置自定义评分参数,从而根据自定义属性定义一个交易计数器。
例如,您可能需要:
- 根据 API 调用消息中提供的值,向开发者收取可变金额。
例如,您可能希望根据 API 请求中传输的字节数向应用开发者收费。 - 将多个 API 调用捆绑到单个事务中。
在这种情况下,请选择“使用自定义评分参数”,然后从下拉列表中选择自定义属性。
如需了解详情,请参阅使用自定义属性配置费率方案。
传统 Edge(私有云)
如需使用经典 Edge 界面配置可调整的通知计划,请执行以下操作:
- 在 Rate Plan Type(费率方案类型)中选择 Adjustable Notification(可调整通知)
字段。
请参阅使用界面创建费率方案 了解有关访问“费率计划”窗口的信息。
- 将续订期限字段设置为方案时的月数 自动续订(除非开发者在该日期之前终止协议)。如果 如果您将此值设为 0,方案将一直有效,直到开发者选择终止方案。
- 点击“Generic Rate Plan”(通用费率方案)下的Details(详细信息)。
- 将 Aggregation Basis 设置为 系统会汇总交易数据请选择一个介于 1 到 24 个月的数字。此值默认为 1 。
- 点击 Apply and Close。
- 点击保存草稿。
- 请仅在您确信其为最终版本时才发布。请参阅发布价格方案
有关如何设置发布日期和发布方案的信息。
发布价格方案后,您只能修改结束日期。您不能删除费率 但您可以使该费率方案失效,并将其替换为未来的费率 如让已发布的费率失效 方案。
使用 API 配置可调整的通知计划
在 ratePlanDetails
属性中指定可调整的通知计划详细信息
添加到 POST 请求的请求正文中,
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
。
要指定可调整的通知计划,请在 请求正文的 ratePlanDetails:
属性 | 值 |
---|---|
type |
设为 USAGE_TARGET 。 |
meteringType |
设为 DEV_SPECIFIC 。 |
duration |
设置为汇总的时间段,以及
durationType 。对于可调整的通知频率方案,请将此值设为整数
介于 1 到 24 之间的值。 |
durationType |
设置为汇总的时间段,以及
|
有关指定 可调整的通知计划详情,请参阅费率方案详情 配置设置。
例如,以下代码定义了基于汇总的可调整通知计划 设为 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
属性(位于向
/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、 "禁用警告":false }' 的\ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1" -u email:password