查看 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%。 |
傳統版 Edge (Private Cloud)
如何使用傳統版 Edge UI 設定收益分潤方案:
- 按照步驟建立費率方案。
- 如要設定收益模式,請在「費率方案類型」下拉式選單中選取「收益分潤」。
- 如果所選 API 套件包含多個 API 產品,請選取下列其中一個選項:
注意:如果 API 套件包含單一 API 產品,您可以略過這個步驟。
- 產品專屬方案:為每項 API 產品分別設定費率方案詳細資料。
- 所有產品的一般方案:為所有 API 產品設定費率方案詳細資料。
- 按一下一般費率方案或各個 API 產品專屬費率方案的「收益分潤」。
注意:設定 API 產品專屬方案時,您必須設定收益分潤方案 以及個別的 API 產品
「收益分潤」視窗隨即開啟。
- 選取下列其中一個共用模式:
- 固定:在此模型中,API 供應商與開發人員分享的比例固定為 每筆交易產生的收益 (根據 $30,000 的總成本或淨額) 交易)。
- 彈性:在這個模型中,API 供應商會與開發人員分享一個變數。 佔收益的百分比收益分潤取決於一段時間內產生的收益 讓應用程式從可以最快做出回應的位置 回應使用者要求系統在計算收益分潤時採用的百分比可能因金額而異 交易產生的收益
固定共用模式:
如果你選擇固定共用模式,請在「定價」中輸入下列資訊 :
欄位 說明 業者 (或機構) 貴機構的名稱。這個欄位是預設的運算子 (或稱「運算子」), ) 欄位值。
國家/地區 貴機構的營運國家/地區。這個欄位預設為使用 機構設定檔中的國家/地區欄位值。
幣別 「基數」貴公司採用的幣別或會計貨幣此為預設設定 使用機構資料中的「貨幣」欄位值。
定價類型 收益分潤的基礎。選取「毛額」或「淨額」。如果選取 [毛], 收益分潤是根據交易總額的百分比計算。如果發生以下情況: 選取 [淨值],收益分潤是以 交易。注意:你在建立交易記錄政策時,可以設定該筆交易的總價或淨淨價。
固定持份百分比 用來計算收益分潤的百分比。請輸入十進位數字 (含 最多到小數點後四位數)。舉例來說,假設您輸入 80.5555,收益分潤就是 80.5555%,也就是說,做為 API 供應商,開發人員須支付價格的 80.5555% 就必須支付每筆交易的費用。
對於靈活的共用模式:
如果選取彈性分享模式,就會看到「一般收益分潤期」視窗 會顯示其他欄位。您可以使用這些欄位指定匯總和 指定「收益區間」,也就是您可以獲得的交易收益範圍 並套用不同的收益分潤百分比
在「一般收益分潤」視窗中輸入下列資訊:
欄位 說明 匯總基礎 匯總收益的時間範圍。匯總收益為 ,用來計算每筆交易的收益金額 (以及適用的收益) 分享百分比)。選取月份數 (1 到 12 之間)。
收益頻帶 交易收益的一或多個範圍 (每個範圍都是「收益區間」)。每項 您可為收益手環指定收益分潤百分比 (也就是 「定價」部分的「收益頻帶」欄位)。交易匯總自 匯總後的計算方法,以便計算總收益和收益區域 交易。每筆交易適用的收益分潤百分比取決於交易的 收益成長幅度
指定第一個錶帶的上限,例如最多 1000 個 (下限為 限制預設為大於 0)。按一下「+」新增第二個錶帶,例如: 1,000 至 2,000 之間。按一下「+」即可新增更多錶帶。可以將上方 最後一個錶帶的限制,用於表示匯總指標發生後的所有交易 收益超過這個水準
定價 業者 (或機構) 貴機構的名稱。這個欄位是預設的運算子 (或稱「運算子」), ) 欄位值。
國家/地區 貴機構的營運國家/地區。這個欄位預設為使用 機構設定檔中的國家/地區欄位值。
幣別 「基數」貴機構組織使用的幣別或會計幣別這個欄位 。
定價類型 收益分潤的基礎。選取「毛額」或「淨額」。如果選取 [毛], 收益分潤是根據交易總額的百分比計算。如果發生以下情況: 選取 [淨值],收益分潤是以 交易。注意:你在建立交易記錄政策時,可以設定該筆交易的總價或淨淨價。
收入區間分享百分比 用來計算每筆交易收益分潤的百分比 收益成長幅度請指定每個錶帶的百分比。請輸入小數 (不含) 到小數點後四位數)舉例來說,假設您在「收益」欄指定兩個收益頻帶 頻帶部分 (>0-1000 和 1000 以上),您可以針對該標籤輸入 80.5555 >0-1000 收益頻帶,1000 以上收益樂團則為 90.5。同時假設 貨幣單位為美元則適用於收益高達 $1000 美元的交易 收益分潤為交易價格的 80.5555% 交易產生的收益超過 $1, 000 美元,收益分潤就是 90.5% 以及交易價格
- 按一下「套用並關閉」,儲存收益分潤詳細資料並返回標準費率 計畫視窗。
- 如果是 API 產品專屬費率方案,請視需要設定其他 API 產品的費率方案詳細資料。
使用 API 指定收益分潤方案詳細資料
建立費率方案時,請指定收益分潤方案詳細資料。由您指定詳細資料
ratePlanDetails
屬性中,呼叫
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
。內容
在 ratePlanDetails
屬性中指定的,取決於您選擇的共用模式:
固定或彈性
為固定分享模式指定收益分潤方案詳細資料
如要導入固定共用模式,請在費率方案詳細資料中指定以下項目:
- 評分參數,表示費率方案是以交易為依據
(
VOLUME
)。預設值為VOLUME
。 - 表示收益分潤為固定的計量類型 (
UNIT
) (也就是說,這並非以交易次數為依據, 共用模型)。 - 收益類型 (
GROSS
或NET
)。這表示 收益分潤是以交易的總價或淨價為基準。 - 付款到期日 (例如 30 天)。
- 貴機構的 ID。
- 「基數」貴公司採用的幣別或會計貨幣
- 費率方案費率,提供收益分潤計算方式的詳細資訊。由於 共用模型是以固定費率為依據,因此你只會指定一個費率方案費率。
如需費率方案詳細資料的完整清單,請參閱費率方案詳細資料的設定屬性。
在費率方案費率中指定:
- 房價方案費率的類型 (
REVSHARE
)。 - 用來計算收益分潤的百分比。舉例來說,如果您指定 80.5555 收益分潤為 80.5555% 也就是說,身為 API 供應商,您需要支付開發人員的 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 到 1,000 (以指定貨幣為單位) 的交易收益。如果
幣別為美元,匯總基礎則為 1 個月,以及收益的百分比
如果當月收益最高達 $1000 美元,則樂團為 80.5555%
收益分潤為交易價格的 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" }