您正在查看 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%。
如果您未为最终收入段指定结束单位，则在总收入超过该段的开始单位后，系统会将该段的份额百分比应用于所有交易。例如，如果最后一个组的起始单位为 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"
}