您正在查看 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 界面配置收入分成方案，请执行以下操作：
- 按照相关步骤创建费率方案。
- 在“费率方案类型”下拉菜单中选择收益分成，以配置收入模型。
- 如果所选 API 软件包包含多个 API 产品，请选择以下选项之一：
注意：如果 API 软件包仅包含一个 API 产品，则可以跳过此步骤。
- 特定于产品的方案，用于单独配置每个 API 产品的费率方案详情。
- 适用于所有产品的通用方案，以配置所有 API 产品的费率方案详细信息。
- 点击通用费率方案或每个 API 产品专用费率方案的收益分成。
注意：配置特定于 API 产品的方案时，您需要为每个 API 产品单独配置收入分成方案。
系统会打开“收益分成”窗口。
- 选择以下共享模式之一：
- 固定：在此模型中，API 提供方会与开发者分成每笔交易产生收益的一定百分比（基于交易的总价或净价）。
- 灵活：在此模型中，API 提供方与开发者分享的收益百分比是可变的。收益分成取决于在一段时间内产生的收入。用于计算收入分成比例的百分比可能会因交易产生的收入金额而有所不同。
对于固定分享模式：
如果您选择固定分成模式，请在“常规收入分成”窗口的“价格”部分中输入以下信息：
字段 说明 运营商（或组织） 您的组织的名称。此字段会使用组织个人资料中的“运营商”（或“组织”）字段值进行预设。
国家/地区 贵组织的运营国家/地区。此字段会使用组织个人资料中的“国家/地区”字段值进行预设。
货币 公司使用的“基本”或会计币种。此字段使用组织个人资料中的“币种”字段值预设。
定价类型 收益分成的基础。选择“毛收入”或“净收入”。如果您选择“毛收入”，则收益分成将基于交易毛价格的百分比。如果您选择“净价”，则收益分成将基于交易净价的百分比。注意：您可以在创建交易记录政策时设置交易的总价或净价。
固定份额百分比 用于计算收益分成的百分比。输入一个小数（最多包含四位小数）。例如，如果您输入 80.5555，则表示收益分成比例为 80.5555%，也就是说，作为 API 提供方，您需要向开发者支付每笔交易价格的 80.5555%。
对于灵活共享模式：
如果您选择灵活的分成模式，会发现“常规收入分成”窗口会显示其他字段。您可以使用这些字段指定聚合依据，并指定“收入范围”，即您可以针对不同的交易生成收入范围应用不同的收入分成百分比。
在“Generic Revenue Share”（一般收益分成）窗口中输入以下信息：
字段 说明 汇总依据 汇总收入的时间段。汇总收入用于计算每笔交易的收入范围（以及适用的收入分成百分比）。选择月份数（介于 1 到 12 之间）。
收入范围 一个或多个交易收入范围（每个范围都是一个“收入段”）。您可以为每个收入范围分配一个收益分成百分比（您可以在“价格”部分的“收入范围”字段中设置此百分比）。交易会根据汇总依据进行汇总，以计算交易的总收入和收入范围。应用于每笔交易的收益分成百分比取决于其收入区间。
指定第一个区间的上限，例如最高为 1000（下限预设为大于 0）。点击“+”可添加第二个频段，例如，大于 1000 且不超过 2000。点击“+”可添加更多频段。您可以将最后一个区间的上限留空，以表示总收入超过此水平后的所有交易。
价格 运营商（或组织） 您的组织的名称。此字段会使用组织个人资料中的“运营商”（或“组织”）字段值进行预设。
国家/地区 贵组织的运营国家/地区。此字段会使用组织个人资料中的“国家/地区”字段值进行预设。
货币 组织使用的“基本”或会计币种。此字段会使用组织个人资料中的“币种”字段值进行预设。
定价类型 收益分成的基础。选择“毛收入”或“净收入”。如果您选择“毛收入”，则收益分成将基于交易毛价格的百分比。如果您选择“净价”，则收益分成将基于交易净价的百分比。注意：您可以在创建交易记录政策时设置交易的总价或净价。
各收入区间的分成百分比 用于计算每个收入区间的交易的收益分成的百分比。您可以为每个频段指定一个百分比。输入一个小数（最多可输入四位小数）。例如，如果您在“收入范围”部分指定了两个收入范围（>0-1000 和 1000 及以上），则可以为“>0-1000”收入范围输入 80.5555，为“1000 及以上”收入范围输入 90.5。另假设币种为美元。然后，对于创收不超过 1,000 美元的交易，收益分成比例为交易价格的 80.5555%；对于创收超过 1,000 美元的交易，收益分成比例为交易价格的 90.5%。
- 点击应用并关闭以保存收益分成详情并返回“标准费率方案”窗口。
- 对于特定于 API 产品的费率方案，请根据需要为其他 API 产品配置费率方案详细信息。
使用 API 指定收益分成方案详细信息
您可以在创建费率方案时指定收益分成方案的详细信息。您可以在对 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 的调用中，通过请求正文内的 ratePlanDetails 属性指定详细信息。您在 ratePlanDetails 属性中指定的内容取决于您选择的共享模式：固定或灵活。
为固定分成模式指定收益分成方案详情
如需实现固定分成模式，您需要在费率方案详情中指定以下内容：
- 一种评级参数，用于指明费率方案基于交易 (
VOLUME)。VOLUME是默认值。 - 一种结算类型 (
UNIT)，表示收入分成是按单位固定的（也就是说，它不是基于交易量，这与灵活的分成模式不同）。 - 收入类型（
GROSS或NET）。这表示收益分成是基于交易的总价还是净价。 - 付款到期期限（例如 30 天）。
- 您组织的 ID。
- 公司使用的“基本”或会计币种。
- 一种费率方案费率，可提供有关如何计算收益分成的详细信息。由于分享模式基于固定费率，因此您只需指定一个费率方案费率。
如需查看费率方案详细信息属性的完整列表，请参阅费率方案详细信息的配置属性。
在费率方案的费率中，您可以指定：
- 费率方案费率的类型 (
REVSHARE)。 - 用于计算收益分成的百分比。例如，如果您指定 80.5555，则表示收益分成比例为 80.5555%，也就是说，作为 API 提供方，您需要向开发者支付每笔交易收取的价格的 80.5555%（或者，如果基于自定义属性，例如交易中传输的字节数，您需要向开发者支付传输指定字节数所收取的价格的 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。
- 公司使用的“基本”或会计币种。
- 时长和时长类型，用于共同指定收入的汇总时间段（也称为“汇总依据”）。系统会根据汇总依据（例如 1 个月）汇总交易，以计算总收入和适用的收入范围。应用于每笔交易的收益分成百分比取决于其收入区间。
- 用于确定适用收入区间的汇总计数器。
如需查看费率方案详细信息属性的完整列表，请参阅费率方案详细信息的配置属性。
对于每种费率方案费率，您需要指定：
- 收入区间的费率方案费率类型 (
REVSHARE)。 - 用于计算相应收入区间的收益分成的百分比。例如，如果您指定 80.5555，则相应收入区间的收益分成比例为 80.5555%，也就是说，作为 API 提供方，您需要向开发者支付该收入区间内每笔交易价格的 80.5555%。
- 收入区间的起始和结束单位。起始单位指定了收入区间的下限，结束单位指定了收入区间的上限。例如，如果您指定的起始单位为 0，结束单位为 1000，则收入范围涵盖交易收入（以指定币种表示）大于 0 且不超过 1000 的交易。如果币种为美元，汇总依据为 1 个月，收入区间的百分比为 80.5555%，那么对于一个月内收入不超过 1,000 美元的交易，收益分成将为交易价格的 80.5555%。
如果您未指定最终收入区间的结束单位，则该区间的分成百分比将应用于所有交易，前提是累计收入已超过该区间的起始单位。例如，如果最后一个区段的起始单位为 1,000（假设为美元），并且您未指定该区段的结束单位，则该区段的收入百分比将应用于汇总期内收入超过 1, 000 美元的所有交易。
如需查看费率方案属性的完整列表，请参阅费率方案的配置属性。
例如，以下代码会创建一个采用灵活分成模式的收入分成方案。它指定了两个收入区间。第一个频段涵盖的交易收入范围为高于 0 美元至最高 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" }