您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
浏览费率方案页面
如下所述,访问费率方案页面。
Edge
如需在 Edge 界面中查看费率方案,请访问“费率方案”页面:
- 登录 apigee.com/edge。
- 在左侧导航栏中,依次选择发布 > 创收 > 费率方案。
此时会显示“费率方案”页面。
如图所示,通过“费率方案”页面,您可以:
传统 Edge (Private Cloud)
如需使用传统版 Edge 界面查看费率方案,请访问“API 软件包”页面:
- 登录
http://ms-ip:9000
,其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 在顶部导航栏中,依次选择发布 > 文件包。
“API 软件包”页面会显示为每个软件包定义的费率方案。
通过“费率方案”页面,您可以:
创建费率方案
要创建费率方案,请执行以下操作:
- 访问“费率方案”页面。
- 点击 +费率方案。
- 在顶部面板中配置以下字段:
字段 说明 默认 必需 费率方案名称 费率方案的名称。 注意:该名称在 API 软件包中必须是唯一的。同一产品包中的两个方案不能同名。
不适用 是 费率方案类型 费率方案类型。从下拉列表中选择一个值。如需查看有效费率方案类型的列表,请参阅支持的费率方案类型。 不适用 是 商品套装 API 软件包。从下拉列表中选择一个值。如需详细了解 API 商品套装,请参阅管理 API 商品套装。 如果您选择的产品包包含多个 API 产品,则需要选择是为每个 API 产品配置单独的费率方案,还是配置适用于所有 API 产品的通用费率方案。
不适用 是 受众 可以访问费率方案的受众群体。从下拉列表中选择以下值之一: - 所有人 - 所有开发者。
- Developer - 开发者或公司。输入开发者名称或公司。输入名称时,下拉列表中会显示包含该字符串的开发者/公司的列表。从下拉列表中选择开发者或公司的名称。
- 开发者类别 - 开发者类别。从下拉列表中选择开发者类别。
按照管理开发者类别中的说明配置开发者类别。
所有人 否 开始日期 费率方案生效的日期。输入开始日期或使用日历选择日期。 今天 否 结束日期 费率方案的结束日期。要指定结束日期,请启用包含结束日期切换开关,然后输入结束日期或使用日历选择日期。 注意:费率方案将在所指定日期的当天结束前生效。例如,如果您希望费率方案在 2018 年 12 月 1 日到期,则应将 endDate 值设置为 2018-11-30。在这种情况下,费率方案将于 2018 年 11 月 30 日结束时到期,届时 2018 年 12 月 1 日的所有请求都会被屏蔽。
无 否 对门户可见 设置费率方案是“公开”还是“不公开”。请参阅公开费率方案和不公开费率方案。 已启用 否 - 为费率方案配置费用。请参阅为费率方案配置费用。
注意:不适用于可调整的通知计划。 - 如果您选择的产品包包含多个 API 产品,请在特定或通用费率方案部分设置以下偏好设置:
注意:此步骤不适用于可调整的通知方案。
字段 说明 默认 单独配置每件商品 此标记指示是否为每个 API 产品配置单独的费率方案。 已停用 单独配置每个产品的免费增值方案 用于指定是否为每个 API 产品配置免费增值方案的标志。 已停用 选择产品 如果您启用其中一个标记或同时启用这两个标记,则必须从下拉列表中选择单个产品,并配置其费率方案的详细信息。 注意:请务必配置此套餐中的所有商品。
不适用 - 根据所选的费率方案类型,配置费率方案的详细信息:
- 点击下列选项之一:
按钮 说明 保存为草稿 将该费率方案保存为草稿。 在您发布费率方案之前,应用开发者不会看到该费率方案。您可以修改费率方案草稿中的任何字段。
发布新方案 发布方案。 注意:发布费率方案后,您只能修改结束日期(如果尚未设置)。费率方案一经发布便无法删除,但您可以使该费率方案过期并将其替换为未来的费率方案,如使已发布的费率方案到期中所述。
- 将创收限制检查政策附加到与费率方案中包含的 API 产品关联的 API 代理。 “创收限制检查”政策对 API 代理强制实施创收限制,并确保在分析和创收报告中准确捕获所有故障。如需了解详情,请参阅对 API 代理强制实施创收限制。
修改费率方案
您可以修改费率方案草稿中除产品包、类型和受众群体之外的所有字段。发布费率方案后,您只能在未指定结束日期的情况下修改结束日期。
如需修改费率方案,请执行以下操作:
- 访问“费率方案”页面。
- 点击您要修改的费率方案对应的行。
系统随即会显示费率方案面板。 - 根据需要修改费率方案字段。
注意:发布费率方案后,您只能修改结束日期(如果尚未设置)。 - 点击下列选项之一:
按钮 说明 更新草稿(费率方案草稿) 将该费率方案保存为草稿。
在您发布费率方案之前,应用开发者不会看到该费率方案。您可以修改费率方案草稿中的任何字段。发布草稿(草稿费率方案) 发布费率方案。
注意:发布费率方案后,您只能修改结束日期(如果尚未设置)。费率方案一经发布便无法删除,但您可以使该费率方案过期并将其替换为未来的费率方案,如使已发布的费率方案到期中所述。更新后的结束日期(已发布的费率方案) 为已发布的方案设置结束日期。
注意:为已发布的费率方案设置结束日期后,便无法再修改结束日期。
删除费率方案草稿
删除不再需要的费率方案草稿。
注意:您无法删除已发布的费率方案。
如需删除费率方案草稿,请执行以下操作:
- 访问“费率方案”页面。
- 将光标悬停在要删除的费率方案上,以显示操作菜单。
- 点击 。
- 点击删除以确认操作。
使用 API 管理费率方案
以下部分介绍了如何使用 API 管理费率方案。
使用 API 创建费率方案
如需创建费率方案,请向 /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
发出 POST 请求,其中 {monetizationpackage_id}
是您为其创建费率方案的 API 产品组合的 ID(当您创建 API 产品组合时,该 ID 会在响应中返回)。
创建费率方案时,您必须在请求正文中指定以下内容:
- 组织 ID
- API 商品套装 ID
- 费率方案的名称
- 费率方案说明
- 费率方案的范围(是适用于所有开发者,还是仅适用于特定的开发者、公司或开发者类别)
- 费率方案生效的日期
- 费率方案的币种
- 是否发布费率方案
- 费率方案是公开还是不公开
您还可以视需要指定其他设置,例如付款期限(例如 30 天)。请参阅费率方案的配置属性。
如果您为包含多个产品的 API 产品组合创建了费率方案(而不是仅采用费用方案),则可以将该方案应用于此产品组合中的特定产品。为此,请在请求中标识商品。如果您未标识产品,方案将应用于 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
使用 API 发布费率方案
如需发布费率方案,请在创建费率方案时将 published
属性值设置为 true。开发者将能够查看从该方案的 startDate
属性中指定的日期开始的费率方案。
例如,以下代码会创建并发布价目表方案(仅显示请求的一部分):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "true", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
使用 API 保存费率方案草稿
若要保存费率方案而不发布,请在创建费率方案时将 published
属性值设置为 false。
例如,以下代码会创建一个价目表方案并将其保存为草稿(只显示部分请求):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "false", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
使用 API 修改费率方案草稿
如需更新费率方案草稿,请向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}
发出 PUT 请求,其中 {package_id}
是 API 软件包的标识,{plan_Id}
是费率方案的标识。进行更新时,您需要在请求正文中指定更新后的设置和费率方案的 ID。如果您要更新费率方案费率,则还需要指定费率方案费率的 ID。例如,以下请求会更新 ID 为 location_flat_rate_card_plan
(突出显示更新)的费率方案中的费率方案费率:
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "location_flat_rate_card_plan", "name": "Flat rate card plan", "advance": "false", "currency": { "id" : "usd" }, "description": "Flat rate card plan", "displayName" : "Flat rate card plan", "frequencyDuration": "30", "frequencyDurationType": "DAY", "earlyTerminationFee": "10", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": "false", "published": "false", "ratePlanDetails": [ { "currency": { "id" : "usd" }, "paymentDueDays": "30", "meteringType": "UNIT", "organization": { "id": "{org_name}" }, "ratePlanRates": [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "type": "RATECARD", "rate": "0.15", "startUnit": "0" } ], "ratingParameter": "VOLUME", "type": "RATECARD" }], "recurringStartUnit": 1, "recurringType": "CALENDAR", "recurringFee": "10", "setUpFee": "10", "startDate": "2013-09-15 00:00:00", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
响应包含更新后的费率方案费率(仅显示部分响应):
… "ratePlanRates" : [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "rate" : 0.15, "startUnit" : 0, "type" : "RATECARD" } ], …
使用 API 查看费率方案
您可以使用 Monetize API 查看费率方案,如以下部分所述。
- 查看使用 API 的组织的所有费率方案
- 使用 API 查看 API 产品套装的所有费率方案
- 使用 API 查看 API 产品套装的费率方案
- 查看使用此 API 的开发者的所有有效费率方案
- 查看使用此 API 的开发者接受的费率方案
- 查看开发者接受的费率方案,其中包含使用 API 的 API 产品
- 查看开发者使用 API 接受的所有费率方案
查看使用 API 的组织的所有费率方案
如需查看组织的所有费率方案,请向 /mint/organizations/{org_name}/rate-plans
发出 GET 请求,其中 {org_name}
是贵组织的名称。
您可以传递以下查询参数来过滤结果:
查询参数 | 说明 |
---|---|
all |
用于指定是否返回所有费率方案的标志。如果设置为 false ,则每页返回的费率方案数量由 size 查询参数定义。默认值为 true 。 |
size |
每页返回的 API 包数量。如果 all 查询参数设置为 true ,此参数会被忽略。 |
page |
要返回的页面编号(如果内容分页)。如果 all 查询参数设置为 true ,此参数会被忽略。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
使用 API 查看 API 产品套装的所有费率方案
如需查看 API 套餐的所有费率方案,请向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
发出 GET 请求,其中 {package_id}
是 API 套餐的 ID(系统会在您创建创收套餐时返回套餐 ID)。
默认情况下,结果中只会返回有效、公开和标准费率方案。添加方法:
- 草稿或过期的费率方案,请将
current
查询参数设置为false
(例如?current=false
)。 - 不公开费率方案,请将
showPrivate
查询参数设置为true
(例如?showPrivate=true
)。 - 对于所有标准费率方案,请将
standard
查询参数设置为true
(例如?standard=true
)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
使用 API 查看 API 软件包的费率方案
如需查看 API 套餐的费率方案,请向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}
发出 GET 请求,其中 {package_id}
是 API 套餐的 ID,{plan_id}
是费率方案的 ID(当您创建创收套餐时会返回套餐 ID,而在您创建费率方案时会返回费率方案 ID)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
以下提供了一个响应示例:
{ "advance" : true, "contractDuration" : 1, "contractDurationType" : "YEAR", "currency" : { "id" : "usd", ... "organization" : { ... }, ... }, "description" : "Standard Fixed Plan", "displayName" : "Standard Fixed Plan", "earlyTerminationFee" : 0.0000, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "communications_standard_fixed_plan", "isPrivate" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Standard Fixed Plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : true, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2", "rate" : 0.0500, "startUnit" : 0, "type" : "RATECARD" } ], "ratingParameter" : "VOLUME", "type" : "RATECARD" } ], "recurringFee" : 200.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 100.0000, "startDate" : "2013-01-11 22:00:00", "type" : "STANDARD" }
查看使用此 API 的开发者的所有有效费率方案
如需查看某个开发者的所有有效费率方案,请向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans
发出 GET 请求,其中 {developer_id}
是开发者的电子邮件地址。
您可以传递以下查询参数来过滤结果:
查询参数 | 说明 |
---|---|
all |
用于指定是否返回所有 API 软件包的标志。如果设为 false ,每页返回的 API 软件包数量由 size 查询参数定义。默认值为 false 。 |
size |
每页返回的 API 包数量。默认值为 20。如果 all 查询参数设置为 true ,此参数会被忽略。 |
page |
要返回的页面编号(如果内容分页)。如果 all 查询参数设置为 true ,此参数会被忽略。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
以下提供了一个响应示例:
{ "ratePlan" : [ { "advance" : true, "contractDuration" : 1, "contractDurationType" : "MONTH", "currency" : { "description" : "United States Dollar", "displayName" : "United States Dollar", "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Fee Only RatePlan", "displayName" : "Fee Only RatePlan", "earlyTerminationFee" : 10.0000, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "WEEK", "id" : "messaging_package_fee_only_rateplan", "isPrivate" : false, "monetizationPackage" : { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, "name" : "Fee Only RatePlan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ ], "recurringFee" : 10.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 20.0000, "startDate" : "2013-02-20 00:00:00", "type" : "STANDARD" } ], "totalRecords" : 1 }
查看使用此 API 的开发者接受的费率方案
如需查看开发者的有效费率方案,请向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
发出 GET 请求,其中 {developer_id}
是开发者的电子邮件地址,{developer_rateplan_id}
是在您接受已发布的费率方案后在响应中返回的已接受费率方案的 ID。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
以下提供了一个响应示例:
{ "created" : "2018-01-25 20:01:54", "developer" : { }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }
查看开发者接受的费率方案,其中包含使用 API 的 API 产品
如需查看包含 API 产品的开发者接受的费率方案,请向 /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product
发出 GET 请求,其中 {developer_id}
是开发者的 ID,/{product_id}
是该产品的 ID。
默认情况下,结果中仅返回公开费率方案。如需显示不公开费率方案,请将 showPrivate
查询参数设置为 true
(例如 ?showPrivate=true
)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
查看开发者使用 API 接受的所有费率方案
如需查看开发者已接受的费率方案,请向 /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
发出 GET 请求,其中 {developer_id}
是开发者的 ID。
您可以传递以下查询参数来过滤结果:
查询参数 | 说明 |
---|---|
all |
用于指定是否返回所有 API 软件包的标志。如果设为 false ,每页返回的 API 软件包数量由 size 查询参数定义。默认值为 false 。 |
size |
每页返回的 API 包数量。默认值为 20。如果 all 查询参数设置为 true ,此参数会被忽略。 |
page |
要返回的页面编号(如果内容分页)。如果 all 查询参数设置为 true ,此参数会被忽略。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
以下提供了一个响应示例:
{ "developerRatePlan" : [ { "created" : "2018-01-25 20:01:54", "developer" : { ... }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }], "totalRecords" : 1 }
使用 API 删除费率方案草稿
如需删除费率方案草稿,请向 /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}
发出 DELETE 请求,其中 {plan_Id}
是要删除的费率方案的标识,{package_id}
是费率方案的 API 软件包。例如:
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
费率方案的配置属性
使用 API 创建费率方案时,您可以指定以下配置设置。
名称 | 说明 | 默认 | 是否必需? |
---|---|---|---|
advance |
仅适用于经常性费用。用于指定是否提前收取周期性费用的标志。有效值包括:
|
false | 否 |
contractDuration |
方案的合同期限与 |
不适用 | 否 |
contractDurationType |
方案的合同期限与
|
不适用 | 否 |
currency |
费率方案所用的币种。指定货币的 ISO 4217 代码,例如 |
不适用 | 是 |
description |
费率方案的说明。 |
不适用 | 是 |
developer |
开发者 ID(电子邮件地址)。仅适用于开发者费率方案。 |
不适用 | 否 |
developerCategory |
开发者类别 ID。仅适用于开发者类别费率方案。 |
不适用 | 否 |
displayName |
费率方案的直观易记的显示名称。 |
不适用 | 是 |
earlyTerminationFee |
开发者在续订期之前终止方案时支付的一次性费用。 |
不适用 | 否 |
endDate |
方案的结束日期。在此日期之后,开发者将无法查看费率方案。如果您不希望费率方案在特定日期结束,请为 费率方案的有效期截至指定日期的当天结束。例如,如果您想在 2016 年 12 月 1 日使费率方案失效,则应将 endDate 值设置为 2016-11-30。在这种情况下,费率方案将在 2016 年 11 月 30 日当天结束时到期,2016 年 12 月 1 日的所有请求都会被屏蔽。 注意:使用 API 查看费率方案时,将 endDate 时间戳指定为 |
不适用 | 否 |
freemiumDuration |
免费增值期限的时间段与 |
不适用 | 否 |
freemiumDurationType |
免费增值期限的时间段与
|
不适用 | 否 |
freemiumUnit |
免费增值数量。该值可以是交易数,也可以是与交易记录政策中记录的自定义属性相关的单元数。 |
不适用 | 否 |
frequencyDuration |
仅适用于经常性费用。周期性费用收费与 |
不适用 | 否 |
frequencyDurationType |
仅适用于经常性费用。周期性费用收费与 frequencyDuration 之间的时段。有效值包括:
|
不适用 | 否 |
isPrivate |
用于指定费率方案是公开还是不公开的标志。默认为 false (公开)。如需了解详情,请参阅公开费率方案和不公开费率方案。 |
不适用 | 否 |
monetizationPackage |
费率方案的 API 产品包 ID。 |
不适用 | 否 |
name |
费率方案的名称。 |
不适用 | 是 |
organization |
费率方案对应的组织 ID。 |
不适用 | 是 |
paymentDueDays |
仅适用于经常性费用。应付费用的天数。例如,将值设置为 30 以表示费用应在 30 天内到期。 |
不适用 | 否 |
proRate |
仅适用于经常性费用。此标记指定在开发者在某月的某段时间开始或结束某个方案时,是否按比例计算周期性费用。有效值包括:
|
false | 否 |
published |
此标记用于指定是否应发布费率方案以供开发者查看。有效值包括:
|
不适用 | 是 |
ratePlanDetails |
费率方案的详细信息(请参阅费率方案详细信息的配置属性)。 |
不适用 | 是 |
recurringFee |
在开发者结束方案之前,系统会持续向开发者收取的费用。 |
不适用 | 否 |
recurringStartUnit |
仅当 |
不适用 | 否 |
recurringType |
定期费用的安排。有效值包括:
|
不适用 | 否 |
setUpFee |
系统在方案开始日期(即开发者购买方案之日)向每位开发者收取的一次性费用。 |
不适用 | 否 |
startDate |
方案的开始日期。开发者能够查看自该日期起的费率方案。 |
不适用 | 是 |
type |
费率方案的类型。指定以下其中一项:
|
不适用 | 是 |
费率方案详情的配置属性
创建费率方案时,您可以将以下任何配置属性指定为 ratePlanDetails
数组的一部分。
名称 | 说明 | 默认 | 是否必需? |
---|---|---|---|
aggregateFreemiumCounters |
此标记指定是否启用汇总计数器,以确定 API 产品的用量是否在免费范围内。必须启用汇总计数器,才能为产品设置免费增值方案。有效值包括:
|
不适用 | 否 |
aggregateStandardCounters |
此标记用于指定是否使用汇总计数器来确定使用范围(如价目表方案的音量范围)。其值可以是以下值之一:
|
不适用 | 否 |
aggregateTransactions |
注意:此属性目前未用于创收,可以忽略。 |
true | 否 |
currency |
Currency(币种)。 |
不适用 | 否 |
duration |
计算频率的时间段,结合 例如,将 |
不适用 | 否 |
durationType |
计算频率的时间段,以及 如需查看用法示例,请参阅 |
不适用 | 否 |
freemiumDuration |
单个 API 产品的免费增值期以及 |
不适用 | 否 |
freemiumDurationType |
单个 API 产品的免费增值期以及
例如,如要指定 API 产品的免费增值期限为 30 天,请将 |
不适用 | 否 |
freemiumUnit |
API 产品的免费增值数量。该值可以是交易数,也可以是与交易记录政策中记录的自定义属性相关的单元数。 |
不适用 | 否 |
meteringType |
价目表方案的收费模式。有效值包括:
|
不适用 | 是 |
organization |
组织 ID。 |
不适用 | 否 |
paymentDueDays |
后付费开发者的付款截止日期。例如,将值设置为 30 以表示付款应在 30 天后到期。 |
不适用 | 否 |
product |
API 产品信息,例如 ID。 |
不适用 | 否 |
ratePlanRates |
费率方案费率详细信息,例如费率方案的类型( |
不适用 | 是 |
ratingParameter |
费率方案的基础。费率方案基于交易或自定义属性。有效值包括:
|
VOLUME |
是 |
ratingParameterUnit |
适用于 |
不适用 | 是 |
revenueType |
收益分成方案中的收益分成基础。有效值包括:
|
不适用 | 否 |
type |
费率方案类型。有效值包括:
如需详细了解费率方案类型,请参阅支持的费率方案类型。 |
不适用 | 是 |