您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
簡介
在收益分潤方案中，API 供應商會將每筆交易產生的收益 (以交易總價或淨價為準) 的一定比例，分給開發人員。建立收益分潤方案時，您需要指出分潤模式 (固定或彈性) 和計價依據 (例如收益分潤是根據交易總價還是淨價)。建立交易記錄政策時，您可以設定交易的總價或淨價。
在固定分潤模式中，你會將每筆交易產生的收益 (以交易總價或淨價為準) 按照固定百分比分給開發人員。在彈性分享模式中，你與開發人員分享的收益百分比會有所變動。收益分潤比例取決於一段時間內產生的收益。用於計算收益分潤的百分比，會因交易產生的收益金額而異。
使用 UI 指定收益分潤方案詳細資料
設定收益分潤方案，詳情請見下文。
邊緣
如要使用 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」(價格) 部分輸入下列資訊：
欄位 說明 營運商 (或機構) 貴機構的名稱。這個欄位會使用機構設定檔中的「營運商」(或「機構」) 欄位值預先設定。
國家/地區 貴機構的營運國家/地區。這個欄位會使用機構付款資料中的「國家/地區」欄位值預先填入。
幣別 公司使用的「基本」或會計貨幣。這個欄位會預先填入機構付款資料中的「幣別」欄位值。
定價類型 收益分潤的依據。選取「總額」或「淨額」。如果選取「總額」，收益分潤將以交易總價的百分比計算。如果選取「淨利」，收益分潤會以交易淨價的百分比計算。注意：建立交易記錄政策時，請設定交易的總價或淨價。
固定分潤百分比 用來計算收益分潤的百分比。輸入小數 (最多可到小數點後四位)。舉例來說，如果輸入 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。並假設幣別為美元。如果交易產生的收益最高達 $1000 美元，收益分潤為交易價格的 80.5555%；如果交易產生的收益超過 $1000 美元，收益分潤為交易價格的 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%，則對於每月收益最高 $1000 美元的交易，收益分潤為交易價格的 80.5555%。
如果未指定最終收益範圍的結尾單位，系統會將該範圍的收益百分比套用至所有交易，前提是累計收益已超過該範圍的起始單位。舉例來說，如果最後一個區間的起始單位為 1000 美元，且您未指定該區間的結束單位，則在匯總期間，凡是收益超過 1000 美元的交易，都會套用該區間的收益百分比。
如需費率方案屬性的完整清單，請參閱「費率方案的設定屬性」。
舉例來說，下列程式碼會建立收益分享方案，並採用彈性分享模式。這項設定指定了兩個收益範圍。第一個級距涵蓋的交易收益為超過 $0 美元至 $1000 美元。第二個級距涵蓋超過 $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" }