您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
简介
在收益分成方案中,API 提供方与开发者分享每笔交易所产生的收入的一定百分比(根据交易的总价或净价)。在创建收益分成方案时,您需要指定一种共享模式(可固定或灵活)以及定价基础(例如,收益分成基于交易的总价还是净价)。您需要在创建交易记录政策时设置交易的总价或净价。
在固定分享模式下,您需要与开发者分享每笔交易产生的收入的固定百分比(根据交易的总价或净价)。在灵活共享模式下,您需要与开发者分享可变的收入百分比。收益分成取决于在一段时间内产生的收入。收益分成计算中所使用的百分比可能会因交易产生的收入金额而异。
使用界面指定收益分成方案详情
配置收益分成方案,如下所述。
Edge
如需使用 Edge 界面配置收益分成方案,请在创建或修改费率方案时,选择收益分成或价目表和收益分成费率方案类型,然后在收益分成部分配置以下信息:
字段 | 说明 |
计算模型 | 选择以下价格类型之一:
|
计算频率 | 计算交易次数(或与自定义属性相关的量)的时间段。选择月数(1-24 个月)。 |
共享模型 | 选择以下收益分成模式之一:
|
固定收益分成 | 对于固定分成模式,请指定用于计算收益分成的百分比。输入一个小数(最多 4 个小数位)。例如,如果您输入“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 (Private Cloud)
如需使用传统版 Edge 界面配置收益分成方案,请执行以下操作:
- 按照相应步骤创建费率方案。
- 在“费率方案类型”下拉菜单中选择收益分成,以配置收入模式。
- 如果所选的 API 软件包包含多个 API 产品,请选择以下选项之一:
注意:如果 API 软件包仅包含单个 API 产品,您可以跳过此步骤。
- 产品专用方案:用于为每个 API 产品分别配置费率方案详情。
- 所有产品的通用方案:为所有 API 产品配置费率方案详情。
- 点击通用费率方案或每个 API 产品专属费率方案的收益分成。
注意:配置 API 产品专用方案时,您需要为每个 API 产品分别配置收益分成方案。
此时将打开“收益分成”窗口。
- 请选择以下共享模式之一:
- 固定:在此模式中,API 提供方与开发者分享每笔交易产生的收入的固定百分比(根据交易的总价或净价)。
- 灵活:在此模型中,API 提供商与开发者分享可变的收入百分比。收益分成取决于在一段时间内产生的收入。收益分成计算中使用的百分比可能会因交易产生的收入金额而异。
对于固定共享模式:
如果您选择固定共享模式,请在“常规收益分成”窗口的“价格”部分中输入以下信息:
字段 说明 运营机构(或组织) 贵组织的名称。此字段是使用组织资料中的运营商(或组织)字段值预设的。
国家/地区 贵组织开展业务的国家/地区。此字段是使用组织资料中的“国家/地区”字段值预设的。
币种 您公司使用的“基本货币”或会计货币。此字段是使用组织资料中的“货币”字段值进行预设的。
定价类型 收益分成基础。选择“毛”或“净”。如果选择“毛”,收益分成基于占交易总价的百分比。如果选择“净收入”,收益分成根据交易净价的百分比来计算。注意:您可以在创建交易记录政策时设置交易的总价或净价。
固定份额百分比 用于计算收益分成的百分比。输入一个小数(最多包含 4 个小数位)。例如,如果您输入 80.5555,收益分成为 80.5555%,也就是说,作为 API 提供商,您向开发者支付每笔交易费用的 80.5555%。
对于灵活共享模式:
如果您选择灵活共享模式,则会发现“常规收益分成”窗口显示更多字段。您可以使用这些字段来指定汇总依据,并指定“收入区间”(即交易产生的收入范围),您可对其应用不同的收益分成比例。
在“常规收益分成”窗口中输入以下信息:
字段 说明 汇总基础 对收入进行汇总的时间段。汇总收入用于计算每笔交易的收入区间(以及相应的收益分成百分比)。选择月数(介于 1 到 12 之间)。
收入区间 交易收入的一个或多个范围(每个范围是一个“收入区间”)。您可以为每个收入区间分配收益分成百分比(您可以在“定价”部分的“收入区间”字段中设置此百分比)。系统会对交易进行汇总,以计算交易的总收入和收入区间。每笔交易适用的收益分成百分比取决于其收入区间。
指定第一个频段的上限,例如最高 1000(下限预设为大于 0)。点击 + 可添加第二个频段,例如大于 1000 和最大 2000。点击 + 可添加更多腕带。您可以将最后一个频段的上限留空,以指明总收入超过此水平后的所有交易。
价格 运营机构(或组织) 贵组织的名称。此字段是使用组织资料中的运营商(或组织)字段值预设的。
国家/地区 贵组织开展业务的国家/地区。此字段是使用组织资料中的“国家/地区”字段值预设的。
币种 贵组织使用的“基本货币”或会计货币。此字段是使用组织资料中的“货币”字段值进行预设的。
定价类型 收益分成基础。选择“毛”或“净”。如果选择“毛”,收益分成基于占交易总价的百分比。如果选择“净收入”,收益分成根据交易净价的百分比来计算。注意:您可以在创建交易记录政策时设置交易的总价或净价。
收入区间的收益分成百分比 用于计算每个收入区间中的交易收益分成的百分比。请为每个频段指定一个百分比。输入一个小数(最多 4 个小数)。例如,如果您在“收入区间”部分指定了两个收入区间(>0-1000 和 1000 及以上),则可以为 >0-1000 的收入区间输入 80.5555,为 1000 及以上的收入区间输入 90.5。另外,假设币种为美元。对于收入不超过 1,000 美元的交易,收益分成为交易价格的 80.5555%;对于收入超过 $1,000 的交易,收益分成为交易价格的 90.5%。
- 点击 Apply and Close 以保存收益分成详情并返回到“标准费率方案”窗口。
- 对于 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.555%(即传输费用的 80.555%)。
- 费率应用的起始单位 (
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 且不超过 1,000 的交易收入(采用指定货币)。如果币种为美元,汇总基础为 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" }