<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
简介
在收益分成方案中,API 提供商会与开发者分享 每笔交易产生的收入(以交易的总价或净价为准)。时间 创建收益分成方案时 您需要指定一种分成模式 或定价方式(例如,收益分成是按总收入还是净收入 交易价格)。您需要在创建交易记录政策时设置交易的总价或净价。
在固定分享模式中,您将与开发者分享固定比例的收益 (以每笔交易的总价或净价为准)。在 则您可以与开发者分享不同比例的收益。通过 收益分成取决于一段时间内产生的收入。在 收益分成的计算方式可能会因交易产生的收入金额而异。
使用以下内容指定收益分成方案详情: 界面
配置收益分成方案,如下所述。
Edge
在创建或修改时使用 Edge 界面配置收益分成方案 请选择收益分成或价目表和收益分成费率方案类型,然后在收益分成部分配置以下信息:
字段 | 说明 |
计算模型 | 选择以下定价类型之一:
|
计算频率 | 计算交易量(或自定义属性相关量)的时间段。选择月份数(1-24 个月)。 |
共享模型 | 选择以下收益分成模式之一:
|
固定收益分成 | 对于固定分成模式,指定用于计算收益分成的百分比。输入十进制数(最多小数点后四位)。例如,如果您输入 80.5555,则收益分成为 80.5555%,也就是说,作为 API 提供商,您需要向开发者支付每笔交易所收取价格的 80.5555%。 |
收益分成区间 | 对于灵活分享模式,可以指定一个或多个交易收入范围(每个范围都是一个“收入区间”)。可以为每个收入区间指定一个收益分成比例。系统在汇总过程中汇总交易数据,以计算交易的总收入和收入区间。每笔交易采用的收益分成百分比取决于其收入区间。 指定第一个频段的上限,例如,最高为 1000(下限预设为大于 0)。点击 +新建可添加其他波段。将最后一个区间的上限留空,以指明总收入超过此水平后的所有交易。 例如,如果您在“收入区间”部分指定了两个收入区间(>0-1000,以及 1000 及以上),则可以为“>0-1000”的收入区间输入 80.5555,为 1000 及以上的收入区间输入 90.5。同时假定货币为美元。然后,对于收入不超过 1,000 美元的交易,收益分成为交易价格的 80.5555%;对于收入超过 1,000 美元的交易,收益分成为交易价格的 90.5%。 |
传统 Edge(私有云)
如需使用传统版 Edge 界面配置收益分成方案,请执行以下操作:
- 按照相应步骤创建价格方案。
- 在“费率方案类型”下拉菜单中选择收益分成,以配置收入模式。
- 如果所选 API 软件包包含多个 API 产品,请选择以下选项之一:
注意:如果 API 软件包中仅包含单个 API 产品,您可以跳过此步骤。
- 产品专用方案:用于单独配置每个 API 产品的费率方案详情。
- 适用于所有产品的通用方案:用于为所有 API 产品配置费率方案详情。
- 点击收益分成,查看通用费率方案或每个 API 产品专用费率方案。
注意:在配置 API 产品专用方案时,您需要配置收益分成方案 。
“收益分成”窗口将会打开。
- 选择以下共享模式之一:
<ph type="x-smartling-placeholder">
- </ph>
- 固定:在此模型中,API 提供商与开发者分享固定百分比的 每笔交易产生的收入(以 交易)。
- 灵活:在此模型中,API 提供商与开发者共享变量, 收入的百分比。收益分成取决于一段时间内产生的收入 。收益分成计算中所用的百分比可能会因付款金额而异 即交易所带来的收入。
对于固定共享模式:
如果您选择固定共享模式,请在“定价”中输入以下信息 部分:
字段 说明 运营商(或组织) 您的组织的名称。此字段是使用 Operator(或 组织)字段值。
国家/地区 贵组织的运营国家/地区。此字段是使用 组织资料中的国家/地区字段值。
货币 “基础”或公司使用的会计货币。此字段为预设字段 使用组织资料中的“货币”字段值。
定价类型 收益分成的依据。选择毛值或净值。如果选择“毛”, 收益分成是指交易额占交易总价的百分比。如果您 如果选择“净”,收益分成 交易。注意:您可以在创建交易记录政策时设置交易的总价或净价。
固定份额 % 用于计算收益分成的百分比。输入一个十进制数(使用 最多四位小数)。例如,如果您输入 80.5555,收益分成为 费用为 80.5555%,也就是说,作为 API 提供商,您需要向开发者支付 。
对于灵活共享模式:
如果您选择灵活分享模式,会注意到“一般收益分成”窗口 会显示附加字段您可以使用这些字段指定聚合的基础, 指定“收入区间”,即您可以设定 采用不同的收益分成比例
在“一般收益分成”窗口中输入以下信息:
字段 说明 汇总基础 汇总收入的时间段。汇总收入为 用于计算每笔交易的收入区间(以及适用的收入 份额百分比)。选择月份数(介于 1 到 12 之间)。
收入区间 一个或多个交易收入范围(每个范围是一个“收入区间”)。每个 您可以为收入范围指定收益分成百分比(您可在 “定价”部分的“收入范围”字段)。交易数据会按 用于计算总收入和收入区间的 交易。每笔交易应用的收益分成比例取决于 收入区间。
指定第一个频段的上限,例如,最高为 1000(即下限 预设为大于 0)。点击 + 可添加第二个腕带,例如, 介于 1000 到 2000 之间。点击 + 可添加更多波段。您可以保留上面的 最终区间的限制为空,以表示汇总后的所有交易 的收入已经高于该水平。
价格 运营商(或组织) 您的组织的名称。此字段是使用 Operator(或 组织)字段值。
国家/地区 贵组织的运营国家/地区。此字段是使用 组织资料中的国家/地区字段值。
货币 “基础”或贵组织使用的会计币种。此字段为 使用组织资料中的“货币”字段值进行预设。
定价类型 收益分成的依据。选择毛值或净值。如果选择“毛”, 收益分成是指交易额占交易总价的百分比。如果您 如果选择“净”,收益分成 交易。注意:您可以在创建交易记录政策时设置交易的总价或净价。
收入区间的分成百分比 用于计算每次交易的收益分成的百分比 收入区间。您需要为每个波段指定百分比。请输入一个十进制数(最多 到小数点后四位)。例如,如果您在“收入”列中指定了两个收入区间, 频段部分(>0-1000,以及 1000 及以上),则可以为 >0-1000 的收入区间,1000 及以上的收入区间为 90.5。还假设 货币单位为美元。然后,针对产生最高 1,000 美元的交易 即收益分成为交易价格的 80.5555%, 对于收入超过 1, 000 美元的交易,收益分成是 交易价格
- 点击应用并关闭,保存收益分成详情并返回“标准费率” “Plan”(规划)窗口。
- 对于 API 产品专用的费率方案,可根据需要为其他 API 产品配置费率方案详细信息。
使用 API 指定收益分成方案详情
您可在创建费率方案时指定收益分成方案详细信息。由您指定详细信息
ratePlanDetails
属性内,在对
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
。您
具体取决于您选择的共享模式:ratePlanDetails
是固定还是灵活的
为固定分成模式指定收益分成方案详情
若要实施固定共享模式,您需要在价格方案详情中指定以下内容:
- 评分参数,表示费率方案基于交易
(
VOLUME
)。VOLUME
是默认值。 - 一种计量类型 (
UNIT
),表示每单位的收益分成是固定的 (也就是说,与使用灵活预算的 共享模型)。 - 收入类型(
GROSS
或NET
)。该参数指示 收益分成则按交易的总价或净价计算。 - 付款期限(例如 30 天)。
- 贵组织的 ID。
- “基础”或公司使用的会计货币。
- 用于详细说明收益分成计算方式的费率方案费率。因为 此共享模式基于固定费率,因此您只能指定一个费率方案费率。
如需查看价格方案详情属性的完整列表,请参阅价格方案详情的配置属性。
在价格方案费率中,您可以指定:
- 费率方案费率的类型 (
REVSHARE
)。 - 用于计算收益分成的百分比。例如,如果您指定“80.5555”, 收益分成为 80.5555%,也就是说,作为 API 提供商,您需要向开发者支付 每笔交易收取的价格(或者,如果基于自定义属性,例如 则需要支付交易费用的 80.5555%, 传输指定数量的字节数)。
- 房价应用的起始单位 (
0
)。这意味着 从第一笔交易开始计算
如需查看价格方案属性的完整列表,请参阅价格方案的配置属性。
例如,以下示例创建了一个采用固定分享模式的收益分成方案。通过 收益分成比例为 80.5555%。收益分成以 交易。该合同于 2013 年 9 月 15 日生效,您需要在 30 天内付款。( 与收益分成相关的详细信息处于突出显示状态。)
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Fixed share plan", "developer":null, "developerCategory":null, "advance": false, "currency": { "id": "usd" }, "description": "Fixed share plan", "displayName": "Fixed share plan", "earlyTerminationFee": 10, "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": false, "published": true, "ratePlanDetails": [ { "aggregateStandardCounters": true, "currency": { "id": "usd" }, "duration": 1, "durationType": "MONTH", "meteringType": "UNIT", "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "ratePlanRates": [ { "revshare": 80.8555, "startUnit": 0, "type": "REVSHARE" } ], "ratingParameter": "VOLUME", "revenueType": "NET", "type": "REVSHARE" } ], "recurringStartUnit": 1, "recurringType": "CALENDAR", "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" \ -u email:password
响应应如下所示(仅显示响应的一部分):
{ "advance" : false, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "description" : "Fixed share plan", "displayName" : "Fixed share plan", "earlyTerminationFee" : 10, "id" : "location_fixed_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Fixed share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "01c4d544-d907-423b-964e-4e2aed2816a3", "revshare" : 80.8555, "startUnit" : 0, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }
为灵活共享模式指定收益分成方案详情
在灵活共享模式中,您可以指定包含一个或多个费率方案的费率方案详细信息 。每个费率方案费率涵盖一系列交易收入(每个范围称为“收入” 乐队”)。您可以为每个收入区间指定收益分成百分比。
除了费率方案费率之外,您还可以在费率方案详细信息中指定以下各项:
- 评分参数,表示费率方案基于交易
(
VOLUME
)。VOLUME
是默认值。 - 一种计量类型 (
VOLUME
),表示收益分成并非基于 交易量(也就是说,它不是固定的,与固定分成 模型)。 - 收入类型(
GROSS
或NET
)。该参数指示 收益分成则按交易的总价或净价计算。 - 付款期限(例如 30 天)。
- 贵组织的 ID。
- “基础”或公司使用的会计货币。
- “持续时间”和“持续时间”类型,共同指定发生收入的时间段 汇总(这也称为“汇总基础”)。交易数据会按 以计算总收入和适用的 收入区间。每笔交易适用的收益分成比例取决于其收入 表带。
- 用于确定适用收入区间的汇总计数器。
如需查看价格方案详情属性的完整列表,请参阅价格方案详情的配置属性。
对于每个价格方案费率,您可以指定:
- 收入区间的费率方案费率类型 (
REVSHARE
)。 - 用于计算收入区间的收益分成的百分比。例如,如果 则收入区间的收益分成为 80.5555%,也就是说,作为 API 则您需要向开发者支付该笔交易所收取的每笔交易价格的 80.5555% 收入区间。
- 收入区间的起始单位和结束单位。起始单位会指定
收入区间的上限,而结束单位则指定收入区间的上限。对于
例如,如果您指定的起始单位为 0,结束单位为 1000,则收入区间
涵盖大于 0 且最高 1000 的交易收入(以特定币种计算)。如果
货币单位为美元,汇总基准为 1 个月,收入百分比
区间为 80.5555%,则对于一个月内产生最多 1000 美元收入的交易,
即交易价格的 80.5555%。
如果您没有为最终收入区间指定结束单位, 在总收入超过 该乐队的起始单位例如,如果最后一个频段的起始单位是 1000 (假设美元),并且您没有指定该乐队的结束单位,即收入 对于交易期间的收入超过 1,000 美元的所有交易, 。
如需查看价格方案属性的完整列表,请参阅价格方案的配置属性。
例如,以下代码创建了一个采用灵活分享模式的收益分成方案。它 指定两个收入区间。第一个区间涵盖的交易收入最高可达 1,000 美元。第二个范围涵盖交易收入超过 1,000 美元的数据。收入 第一个收入区间为 80.5555%,第二个收入区间为 90.5%。 收益分成按交易的净价计算。汇总基准为 1 个月。 合同期于 2013 年 9 月 15 日生效,您需要在 30 天内付款。(收入 与共享相关的详细信息会突出显示。)
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flexible share plan", "developer":null, "developerCategory":null, "advance": "true", "currency": { "id": "usd" }, "description": "Flexible share plan", "displayName": "Flexible share plan", "frequencyDuration": "30", "frequencyDurationType": "DAY", "earlyTerminationFee": "10", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": "false", "published": "true", "ratePlanDetails": [ { "currency": { "id": "usd" }, "duration": "1", "durationType": "MONTH", "meteringType": "VOLUME", "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "ratePlanRates" : [ { "endUnit" : 1000, "revshare" : 80.5555, "startUnit" : 0, "type" : "REVSHARE" }, { "revshare" : 90.5, "startUnit" : 1000, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "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" \ -u email:password
响应应如下所示(仅显示响应的一部分):
{ "advance" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, ... }, "description" : "Flexible share plan", "displayName" : "Flexible share plan", "earlyTerminationFee" : 10, "frequencyDuration" : 30, "frequencyDurationType" : "DAY", "id" : "location_flexible_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Flexible share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : false, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", … "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c", "meteringType" : "VOLUME", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "endUnit" : 1000, "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40", "revshare" : 80.5555, "startUnit" : 0, "type" : "REVSHARE" }, { "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed", "revshare" : 90.5, "startUnit" : 1000, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringFee" : 10, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }