<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
浏览价格方案页面
访问“价格方案”页面(如下所述)。
Edge
如需在 Edge 界面中查看费率方案,请访问“费率方案”页面:
- 登录 apigee.com/edge。
- 选择发布 >创收 >“价格套餐”。
此时会显示“费率方案”页面。
如图所示,您可以通过“费率方案”页面执行以下操作:
传统 Edge(私有云)
如需使用传统版 Edge 界面查看费率方案,请访问“API 套餐”页面:
- 登录
http://ms-ip:9000
,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 选择发布 >软件包。
“API 套餐”页面会显示为每个套餐定义的费率方案。
通过“费率方案”页面,您可以:
创建价格方案
如需创建价格方案,请执行以下操作:
- 访问“费率方案”页面。
- 点击 + 费率方案。
- 在顶部面板中配置以下字段:
字段 说明 默认 必填 价格方案名称 您的价格方案的名称。 注意:该名称在 API 产品软件包中必须是唯一的。同一产品套装中的两个方案不能重名。
不适用 是 价格方案类型 价格方案类型。从下拉列表中选择一个值。如需查看有效的费率方案类型列表,请参阅支持的费率方案类型。 不适用 是 商品套装 API 产品套装。从下拉列表中选择一个值。如需详细了解 API 产品套装,请参阅管理 API 产品套装。 如果您选择的产品套装包含多个 API 产品,则需要选择是为每个 API 产品配置单独的费率方案,还是配置适用于所有 API 产品的通用费率方案。
不适用 是 受众 可访问费率方案的受众群体。从下拉列表中选择以下值之一: - 所有人 - 所有开发者。
- 开发者 - 开发者或公司。输入开发者名称或公司名称。在您输入时,下拉列表中会显示一个包含该字符串的开发者/公司列表。在下拉列表中点击开发者或公司的名称。
- 开发者类别 - 开发者类别。从下拉列表中选择开发者类别。
根据需要配置开发者类别,如管理开发者类别中所述。
所有人 否 开始日期 费率方案的生效日期。输入开始日期或使用日历选择日期。 今天 否 结束日期 价格方案的结束日期。要指定结束日期,请启用包含结束日期切换开关,然后输入结束日期或使用日历选择日期。 注意:该费率方案的有效期会持续到指定日期的当天结束。例如,如果您想在 2018 年 12 月 1 日过期价格方案,则应将 endDate 值设置为 2018-11-30。在这种情况下,价格方案将于 2018 年 11 月 30 日结束时失效;2018 年 12 月 1 日的所有请求都将被屏蔽。
无 否 对门户可见 设置价格方案是公开还是不公开。请参阅公开价格方案与不公开价格方案。 已启用 否 - 配置价格方案的费用。请参阅为费率方案配置费用。
注意:不适用于可调整的通知计划。 - 如果您选择的产品套装包含多个 API 产品,请在特定或通用费率方案部分设置以下偏好设置:
注意:此步骤不适用于可调整的通知计划。
字段 说明 默认 单独配置每个产品 用于指定是否为每个 API 产品配置单独的费率方案的标志。 已停用 单独配置每个产品的免费增值优惠 用于指定是否为每个 API 产品配置免费增值方案的标志。 已停用 选择产品 如果您启用了其中一个或两个标记,则必须从下拉列表中选择每个产品,并配置其价格方案详细信息。 注意:请确保配置该捆绑包中的所有产品。
不适用 - 根据所选的价格方案类型配置价格方案详情:
<ph type="x-smartling-placeholder"> - 点击下列选项之一:
按钮 说明 保存为草稿 将该价格方案保存为草稿。 在您发布此价格方案之前,应用开发者不会看到此价格方案。您可以修改费率方案草稿中的任何字段。
发布新方案 发布方案。 注意:发布价格方案后,您只能修改尚未设置的结束日期。您无法删除已发布的价格方案,但可以使该价格方案失效,然后将其替换为未来的价格方案,如让已发布的价格方案到期中所述。
- 将创收限制检查政策附加到与费率方案中包含的 API 产品相关联的 API 代理。 “创收限额检查”政策将对 API 代理强制执行创收限额,并确保在 查看分析数据和创收报告如需了解详情,请参阅 对 API 代理强制执行创收上限。
修改价格方案
您可以修改草稿费率方案中的所有字段(产品套装、类型和受众群体除外)。发布价格方案后 只有在没有指定结束日期的情况下才能修改结束日期。
如需修改价格方案,请执行以下操作:
- 访问“费率方案”页面。
- 点击您要修改的价格方案所在的行。
系统随即会显示价格方案面板。 - 根据需要修改价格方案字段。
注意:发布价格方案后,您只能修改尚未设置的结束日期。 - 点击下列选项之一:
按钮 说明 更新草稿(草稿费率方案) 将该价格方案保存为草稿。
在您发布此价格方案之前,应用开发者不会看到此价格方案。您可以修改费率方案草稿中的任何字段。发布草稿(草稿费率方案) 发布费率方案。
注意:发布价格方案后,您只能修改尚未设置的结束日期。您无法删除已发布的价格方案,但可以使该价格方案失效,然后将其替换为未来的价格方案,如让已发布的价格方案到期中所述。更新后的结束日期(已发布的价格方案) 设置已发布方案的结束日期。
注意:已发布的价格方案的结束日期后,便无法再修改。
删除草稿价格方案
如果不再需要草稿费率方案,请将其删除。
注意:您无法删除已发布的价格方案。
如需删除价格方案草稿,请按以下步骤操作:
- 访问“费率方案”页面。
- 将光标放在 要删除的价格方案以显示操作菜单。
- 点击 。
- 点击删除以确认操作。
使用 API 管理费率方案
以下部分介绍了如何使用 API 管理费率方案。
使用 API 创建价格方案
要创建价格方案,请向以下地址发出 POST 请求:
/organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
,
其中,{monetizationpackage_id}
是您为其创建 API 产品套装的 ID。
费率方案(创建 API 产品套装时,此 ID 会在响应中返回)。
创建费率方案时,您必须在请求正文中指定以下内容:
- 组织 ID
- API 产品套装 ID
- 价格方案的名称
- 价格方案说明
- 费率方案的范围(是适用于所有开发者,还是仅适用于 开发者、公司或开发者类别)
- 价格方案的生效日期
- 价格方案所用的币种
- 是否发布费率方案
- 价格方案是公开的还是不公开的
您还可以指定其他设置,如付款周期 到期日(例如 30 天)。请参阅费率方案的配置属性。
如果您为超过 一个产品,您可以将该方案应用于该产品套装中的某个特定产品。为此,您需要 来标识请求中的商品如果您无法识别某个产品,则该方案为 会应用于 API 产品套装中的所有产品
以下部分介绍了如何创建价格方案:
- 使用 API 创建标准费率方案
- 使用 API 创建开发者或公司费率方案
- 使用 API 创建开发者类别费率方案
- 使用 API 创建特定于 API 产品的费率方案
- 使用 API 将费率方案设置为公开或不公开
使用 API 创建标准费率方案
如需创建标准费率方案,请将 type
属性设置为 STANDARD
。
如以下示例中所示。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : false, "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 创建开发者或公司费率方案
若要将此费率方案应用于特定开发者或公司,请将 type
值设置为
Developer
。您还需要在请求中指明开发者或公司
识别 ID、法定名称和公司开发者名称。
例如,以下代码段为Dev Five
创建了费率方案
开发者:
... "type": "DEVELOPER", "developer" : { "id" : "0mkKu1PALUGfjUph", "legalName" : "DEV FIVE", "name" : "Dev Five" } ...
使用 API 创建开发者类别费率方案
如需将费率方案应用于某个开发者类别,请将 type
值设置为
Developer_Category
。您还需要在请求中指明开发者类别。
例如:
... "type": "DEVELOPER_CATEGORY", "developerCategory" : { "id" : "5e172299-8232-45f9-ac46-40076139f373", "name" : "Silver", "description" : "Silver category" } ...
使用 API 创建特定于 API 产品的费率方案
为包含多个 API 产品的 API 产品集合创建费率方案时,您可以分别为 API 产品指定费率方案详细信息。
例如,以下示例创建了包含两款 API 产品的收益分成方案:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Multi-product rate plan", "currency": { "id" : "usd" }, "description": "Multi-product rate plan", "displayName" : "Multi-product rate plan", "monetizationPackage": { "id": "mypackage", ... }, "organization": { "id": "{org_name}", ... }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":0, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product1","displayName":"Product1"}, "customPaymentTerm":false }, { "ratePlanRates":[{ "revshare":10, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product2","displayName":"Product2"}, "customPaymentTerm":false } ], "startDate": "2019-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \ -u email:password
要向 my-package
API 产品套装添加 API 产品,您需要向
在请求正文中包含 API 产品的费率方案详情,如使用 API 产品专用费率方案向 API 产品套装添加 API 产品中所述。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "my-package_multi-product-rate-plan", "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":20, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "customPaymentTerm":false }] }] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \ -u email:password
使用 API 将费率方案设置为公开或不公开
创建价格方案时,您可以使用
isPrivate
属性。如果设置为 true
,则价格方案
将设为不公开。有关详情,请参阅公共
和非公开价格方案。
例如,以下命令创建了一个不公开费率方案:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : 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