您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info
簡介
在收益分潤方案中，API 供應商會將每筆交易產生的收益 (以交易的總價或淨價為準) 的百分比與開發人員分享。建立收益分潤企劃書時，您需要指定分潤模式 (可為固定或彈性) 和定價依據 (例如收益分潤是否以交易的總價或淨價為準)。您可以在建立交易記錄政策時設定交易的總價或淨價格。
在固定分潤模式中，您會與開發人員分享每筆交易產生的收益 (以交易的總價或淨價為準) 的固定百分比。在彈性分潤模式中，你可與開發人員分享收益的不同百分比。收益分潤取決於一段時間內產生的收益。收益分潤計算時使用的百分比，可能會因交易產生的收益金額而異。
使用 UI 指定收益分潤方案詳細資料
按照下方說明設定收益分潤方案。
Edge
如要使用 Edge UI 設定收益分成方案，請在建立或編輯費率方案時，選取「收益分成」或「費率表和收益分成」費率方案類型，然後在「收益分成」部分設定下列資訊：
| 欄位 | 說明 |
| 計算模型 | 請選取下列其中一種定價類型：
|
| 計算頻率 | 計算交易量 (或自訂屬性相關的交易量) 的時間範圍。選取月數 (1 至 24 個月)。 |
| 共用模式 | 請選取下列其中一種收益分潤模式：
|
| 固定收益分潤 | 針對固定分潤模式，指定用於計算收益分潤的百分比。請輸入十進位數字 (最多到小數點後四位數)。舉例來說，如果您輸入 80.5555，收益分潤就是 80.5555%，也就是說，身為 API 供應商，您會向開發人員支付每筆交易收取價格的 80.5555%。 |
| 收益分潤區間 | 在彈性分享模式中，交易收益範圍 (每個範圍都是一個「收益區間」)。每個收益區間都可以指定收益分潤百分比。系統會根據匯總依據匯總交易，以便計算交易的總收益和收益區間。每筆交易適用的收益分潤百分比，視其收益來源而定。 指定第一個頻帶的上限，例如上限為 1000 (下限預設為大於 0)。按一下「+ 新增」即可新增其他錶帶。將最後一個頻帶的上限留空，表示匯總收益超過這個等級後的所有交易。 舉例來說，如果您在「收益手環」部分 (>0-1000 和 1000 及以上) 指定了兩個收益來源，您可以分別為 >0-1000 收益手環輸入 80.5555，以及 1000 與上述收益區間輸入 90.5。另外，假設貨幣為美元。接著，如果交易產生的收益最高為 $1000 美元，收益分潤則為交易價格的 80.5555%，如果產生的收益超過 $1000 美元，收益分潤則為交易價格的 90.5%。 |
Classic Edge (Private Cloud)
如要使用 Edge 傳統版 UI 設定收益分潤方案，請按照下列步驟操作：
- 按照這篇文章的步驟建立費率方案。
- 如要設定收益模式，請在「費率方案類型」下拉式選單中選取「收益分潤」。
- 如果所選 API 套件包含多個 API 產品，請選取下列其中一個選項：
注意：如果 API 套件只包含單一 API 產品，您可以略過這個步驟。
- 產品專屬方案，為每個 API 產品個別設定費率方案詳細資料。
- 所有產品的一般方案：設定所有 API 產品的費率方案詳細資料。
- 按一下「收益分潤」，即可查看一般費率方案或各個 API 產品專屬費率方案。
注意：設定 API 專屬方案時，您必須為每個 API 產品個別設定收益分成方案。
收益分潤視窗隨即開啟。
- 選取下列任一共用模式：
- 固定：在這個模式中，API 供應商會將每筆交易產生的收益 (根據交易的總價或淨價) 的固定百分比與開發人員分享。
- 彈性：在這個模式中，API 供應商會與開發人員分享可變的收益百分比。收益分潤取決於一段時間內產生的收益。系統在計算收益分潤時採用的百分比，可能因交易產生的收益金額而異。
固定分享模式：
如果您選取固定分潤模式，請在「Generic Revenue Share」視窗的「Pricing」部分輸入下列資訊：
欄位 說明 經營者 (或機構) 貴機構的名稱。這個欄位會使用機構設定檔中的「Operator」(或「Organization」) 欄位值預先設定。
國家/地區 貴機構的營業所在地。這個欄位會使用機構設定檔中的「國家/地區」欄位值預設。
幣別 貴公司使用的「基本」或會計貨幣。這個欄位會使用機構設定檔中的「貨幣」欄位值預設。
定價類型 收益分潤的依據。選取「總價」或「淨價」。如果選取「總價」，收益分潤會以交易總價的百分比計算。如果選取「淨額」，收益分潤會以交易淨價的百分比計算。注意：您可以在建立交易記錄政策時，設定交易的總價或淨價。
固定分潤百分比 用來計算收益分潤的百分比。輸入小數 (最多小數點後四位)。舉例來說，如果您輸入 80.5555，收益分潤就是 80.5555%，也就是說，身為 API 供應商，您會向開發人員支付每筆交易收取價格的 80.5555%。
靈活的共用模式：
如果選取彈性分潤模式，您會發現「Generic Revenue Share」視窗會顯示其他欄位。您可以使用這些欄位指定匯總依據，並指定「收益區間」，也就是交易產生收益的範圍，以便套用不同的收益分潤百分比。
在「Generic Revenue Share」視窗中輸入下列資訊：
欄位 說明 匯總依據 匯總收益的時間範圍。系統會使用匯總收益來計算每筆交易的收益區間 (以及適用的收益分潤百分比)。選取月數 (介於 1 到 12 之間)。
收益區間 一或多個交易收益範圍 (每個範圍都是「收益區間」)。每個收益區間都可以指派收益分潤百分比 (您可以在「價格」部分的「收益區間」欄位中設定這項百分比)。系統會根據匯總依據將交易匯總，以便計算交易的總收益和收益區間。每筆交易適用的收益分潤百分比，取決於其收益區間。
指定第一個頻帶的上限，例如上限為 1000 (下限預設為大於 0)。按一下「+」即可新增第二個錶帶，例如大於 1000 和 2000。按一下「+」即可新增更多頻帶。您可以將最終頻帶的上限留空，以便指出總收益超過這個等級後的所有交易。
定價 經營者 (或機構) 貴機構的名稱。這個欄位會使用機構設定檔中的「Operator」(或「Organization」) 欄位值預先設定。
國家/地區 貴機構的營業所在地。這個欄位會使用機構設定檔中的「國家/地區」欄位值預設。
幣別 貴機構使用的「基本」或會計貨幣。這個欄位會使用機構設定檔中的「貨幣」欄位值預先設定。
定價類型 收益分潤的依據。選取「總價」或「淨價」。如果選取「總價」，收益分潤會以交易總價的百分比計算。如果選擇「淨收益」，收益分潤會以交易淨價格的百分比為依據。注意：您在建立交易記錄政策時，可以設定該筆交易的總價或淨額。
收益區間的收益分潤百分比 用來計算每個收益區間交易收益分潤的百分比。您可以為每個頻帶指定百分比。輸入小數 (最多小數點後四位)。舉例來說，如果您在「收益區間」部分指定兩個收益區間 (>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 (假設美元)，而且您沒有為該樂團指定結束單位，則該頻帶的收益百分比會套用到匯總期間收益超過 $1000 美元的所有交易。
如需完整的費率方案屬性清單，請參閱「費率方案的設定屬性」。
例如，以下會建立採用彈性分享模式的收益分潤方案。並指定兩個收益區間。第一個樂團涵蓋交易收益，最高超過 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"
}