您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
簡介
在收益分潤方案中，API 供應商會與開發人員分享每筆交易產生的收益百分比 (以交易總額或淨價格計算)。建立收益分潤方案時，您必須指明共享模式，可以是固定或彈性，也可採用計價模式 (例如收益分潤是以交易的毛利或淨價格為計算依據)。建立交易記錄政策時，您可以設定交易的總金額或淨價。
在固定共享模式中，開發人員會從每筆交易產生的收益中，按固定百分比與開發人員分享 (依交易的毛利或淨價計算)。在彈性共用模式下，您可以與開發人員共用一定比例的收益。收益分潤取決於在一段時間內產生的收益。計算收益分潤時使用的百分比可能因交易產生的收益金額而異。
透過使用者介面指定收益分潤方案的詳細資料
設定收益分潤方案，詳情請參閱下文。
Edge
如要使用 Edge UI 設定收益分潤方案，請在建立或編輯費率方案時，選取「收益分潤」或「價目表和收益分潤」費率方案類型，然後在「收益分潤」部分中設定下列資訊：
| 欄位 | 說明 |
| 計算模型 | 請選取下列其中一種定價類型：
|
| 計算頻率 | 計算交易量 (或自訂屬性相關量) 的時間範圍。選取月數 (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%。 |
傳統邊緣 (Private Cloud)
如何透過傳統版 Edge UI 設定收益分潤方案：
- 請按照這些步驟建立費率方案。
- 在「費率方案類型」下拉式選單中，選取「收益分潤」，設定收益模式。
- 如果選取的 API 套件包含多個 API 產品，請選取下列其中一個選項：
注意：如果 API 套件包含單一 API 產品，您可以略過這個步驟。
- 產品專屬方案：分別設定各項 API 產品的費率方案詳細資料。
- 所有產品的一般方案：設定所有 API 產品的費率方案詳細資料。
- 針對一般費率方案或每個 API 產品專屬費率方案，按一下「收益分潤」。
注意：設定 API 產品專屬方案時，您必須分別為各項 API 產品設定收益分潤方案。
「收益分潤」視窗會隨即開啟。
- 選取下列其中一種共用模式：
- 固定：在這個模式中，API 供應商會與開發人員分享每筆交易產生的收益固定百分比 (以交易的總額或淨價為準)。
- 彈性：在這個模式中，API 供應商會與開發人員共用收益的變動百分比。收益分潤取決於在一段時間內產生的收益。計算收益分潤時使用的百分比可能因交易產生的收益金額而異。
固定共用模式：
如果您選取固定共享模式，請在「一般收益分潤」視窗的「定價」部分輸入下列資訊：
欄位 說明 業者 (或機構) 貴機構的名稱。系統會使用機構設定檔中的「運算子」(或機構) 欄位值來預設這個欄位。
國家/地區 貴機構的營運國家/地區。系統會使用機構資料中的「國家/地區」欄位值來預設這個欄位。
幣別 貴公司使用的「基準」或會計貨幣。系統會使用機構資料中的「貨幣」欄位值來預設這個欄位。
定價類型 收益分潤的基礎。選取「總收益」或「淨額」。如果選取「毛額」，收益分潤是根據交易總價的百分比計算而得。如果選取「淨」，收益分潤是依據交易的淨價格百分比計算。注意：您可以在建立交易記錄政策時，設定交易的毛總額或淨價。
固定分享百分比 用於計算收益分潤的百分比。輸入十進位數字 (最多小數點後四位數)。例如，如果您輸入 80.5555，則收益分潤為 80.5555%，也就是說，身為 API 供應商，您需要向開發人員支付每筆交易價格的 80.5555%。
彈性共用模式：
如果選取彈性共享模式，「一般收益分潤」視窗會顯示額外的欄位。您可以使用這些欄位指定匯總基準，並指定「收益區間」，也就是可套用不同的收益分潤百分比的交易產生的收益範圍。
在「一般收益分潤」視窗中輸入下列資訊：
欄位 說明 匯總基礎 匯總收益的時間範圍。匯總收益會用來計算每筆交易的收益頻帶 (和適用的收益分潤百分比)。選取月份 (1 到 12 之間)。
收益頻帶 一或多個交易收益範圍 (每個範圍都是「收益區間」)。每個收益區間都可以指定收益分潤百分比 (您可以在「定價」專區的「收益區間」欄位中設定這個百分比)。系統會根據匯總方式匯總交易，計算交易的總收益和收益頻帶。套用至每筆交易的收益分潤百分比，取決於其收益區塊。
指定第一個頻帶的上限，例如最多 1000 (下限預設大於 0)。按一下 + 即可新增第二個頻帶，例如大於 1000 且到 2000 之間。按一下 + 即可新增更多錶帶。您可以將最後一個頻帶的最大值留空，表示匯總收益超過這個門檻後的所有交易。
定價方式 業者 (或機構) 貴機構的名稱。系統會使用機構設定檔中的「運算子」(或機構) 欄位值來預設這個欄位。
國家/地區 貴機構的營運國家/地區。系統會使用機構資料中的「國家/地區」欄位值來預設這個欄位。
幣別 貴機構使用的「基準」或會計貨幣。系統會使用機構設定檔中的「貨幣」欄位值來預設這個欄位。
定價類型 收益分潤的基礎。選取「總收益」或「淨額」。如果選取「毛額」，收益分潤是根據交易總價的百分比計算而得。如果選取「淨」，收益分潤是依據交易的淨價格百分比計算。注意：您可以在建立交易記錄政策時，設定交易的毛總額或淨價。
收益分潤比例 (百分比) 計算每個收益頻帶交易收益分潤的百分比。為每個頻帶指定百分比。輸入十進位數字 (最多小數點後四位數)。舉例來說，如果在「收益頻」部分 (>0-1000 和 1000 以上) 指定兩個收益頻帶，可以為 >0-1000 的收益區間輸入 80.5555，在 1000 以上收益區間輸入 90.5。並假設貨幣以美元為單位。如果是收益最高可達 $1,000 美元的交易，收益分潤為交易價格的 80.5555%；如果交易收益超過 $1,000 美元，收益分潤為交易價格的 90.5%。
- 按一下「Apply and 關閉」儲存收益分潤詳細資料，並返回標準費率方案視窗。
- 如果是 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% 的傳輸位元組數給開發人員。
- 費率應用程式的起始單位 (
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"
}