您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
借助免费增值方案,应用开发者可根据用量和/或时长免费使用费率方案。 您可以为任何费率方案类型(可调整通知除外)配置免费增值方案。
通过界面配置免费增值方案
如下所述,为费率方案配置免费增值方案。
Edge
如需在创建或修改费率方案时使用 Edge 界面配置免费增值方案,请选择任意费率方案类型(可调整通知除外),并在免费增值部分启用免费增值方案并选择以下选项之一:
- 按用量(API 调用次数)提供的服务
- 优惠(按时段)
- 二者取其先
根据您的选择,配置以下一个或两个字段:
字段 | 说明 |
---|---|
免费增值使用量(API 调用) | 注意:如果您选择按数量提供优惠或先到先得,则必须提供。
开发者无需付费的交易(或与交易记录政策中记录的自定义属性相关的价值)的数量。用量是针对 API 产品来衡量的。 |
免费增值期限 | 注意:如果您选择按持续时间优惠或先到先得,则必须选择此项。
系统未向开发者收费的时间间隔。例如,30 天。指定数字和单位(天、周或月)。 |
传统 Edge (Private Cloud)
如需使用传统版 Edge 界面配置免费增值方案,请执行以下操作:
- 选择“免费增值”标签页。
- 输入以下信息:
字段 说明 是否采用了免费增值套餐? 免费期的范围。选中以下单选按钮之一:
- 按数量。免费期限基于“容量”字段中指定的数量。
- 按时长。免费期限基于“免费增值时长”字段中指定的时间间隔。
- 二者取其先。当达到“数量”字段中的数量或“免费增值时长”字段中的时间间隔时(二者取其先),免费期将结束。
- 不可以。这不是免费增值方案。这是默认值。
免费增值量 开发者需要支付的交易量(或与交易记录政策中记录的自定义属性相关的交易量)。用量是 API 软件包中所有产品的用量。输入卷号,如 5000。 这意味着,当开发者启动该方案时,他们不需要为前 5,000 笔交易(或自定义属性相关商品的前 5,000 次使用)付费。仅当您在“免费增值包?”字段中选择“按数量”或“先到先得”时,此字段才会启用。
免费增值时长 系统未向开发者收费的时间间隔。输入一个数字并选择一个时间段,例如 1 个月。这意味着,开发者无需从购买方案的开始日期起的 1 个月内付费。只有在“免费增值套餐?”字段中选择“按时长”或“先到先得”时,此字段才会启用。
使用 API 将免费增值方案配置为费率方案
您可以在创建或更新费率方案时添加免费增值方案。您可以在调用的请求正文中指定免费增值属性。
例如,以下请求创建了一个免费增值期限为 30 天的标准费率方案。(突出显示了与免费增值相关的规范)。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "freemiumDuration": "30", "freemiumDurationType": "DAY", "monetizationPackage": { "id": "location_package" }, "organization": { "id": "{org_name} }, "published": "true", "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
如需指定基于免费增值的数量(例如涉及 API 软件包的交易数量,或与交易记录政策中记录的自定义属性相关的交易量),请将其指定为免费增值单位的数量。例如,以下属性分配指定免费增值是以 5,000 个免费增值单位为基础:
"freemiumUnit": "5000"
如需查看费率方案选项的完整列表,请参阅费率方案配置设置。