查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
探索費率方案頁面
前往費率方案頁面 (如下所述)。
Edge
如要在 Edge UI 中查看費率方案,請前往「費率方案」頁面:
- 登入 apigee.com/edge。
- 選取「發布」>「發布」營利 >費率方案。
系統隨即會顯示「費率方案」頁面。
如圖所示,「費率方案」頁面可讓你執行下列操作:
傳統版 Edge (Private Cloud)
如要使用傳統版 Edge UI 查看費率方案,請存取「API 套件」頁面:
- 登入「
http://ms-ip:9000
」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。 - 選取「發布」>「發布」套件位於頂端導覽列中。
API 套件頁面會顯示每個套件定義的費率方案。
你可以透過「費率方案」頁面執行下列操作:
建立費率方案
如何建立費率方案:
- 前往費率方案頁面。
- 按一下「+費率方案」。
- 在頂端面板中設定下列欄位:
欄位 說明 預設 必填 房價方案名稱 房價方案的名稱。 注意:API 產品組合中的名稱不得重複。同一產品套裝組合中的兩個方案不得使用相同的名稱。
無 是 房價方案類型 房價方案類型。從下拉式清單中選取值。如需有效的費率方案類型清單,請參閱「支援的費率方案類型」一文。 無 是 產品組合 API 產品套裝組合。從下拉式清單中選取值。如要進一步瞭解 API 產品套裝組合,請參閱管理 API 產品套裝組合。 如果產品套裝組合包含多個 API 產品,您必須選取要為每個 API 產品設定個別費率方案,或是套用至所有 API 產品的一般費率方案。
無 是 目標對象 可查看房價方案的目標對象。從下拉式清單中選取下列其中一個值: - 所有人 - 所有開發人員。
- 開發人員 - 開發人員或公司。輸入開發人員名稱或公司。輸入文字時,含有字串的開發人員/公司清單會顯示在下拉式選單中。在下拉式清單中按一下開發人員或公司名稱。
- 開發人員類別 - 開發人員類別。從下拉式清單中選取開發人員類別。
按照「管理開發人員類別」的說明,設定必要開發人員類別。
適合所有人 否 開始日期 房價方案生效的日期。輸入開始日期,或使用日曆選取日期。 今天 否 結束日期 房價方案的結束日期。如要指定結束日期,請啟用「含結束日期」切換鈕,然後輸入結束日期,或使用日曆選取日期。 注意:房價方案的有效期限為指定日期的當天結束。舉例來說,如果您想在 2018 年 12 月 1 日到期費率方案,請將 endDate 值設為 2018-11-30。在這種情況下,房價方案將於 2018 年 11 月 30 日結束時到期。2018 年 12 月 1 日提出的所有要求都會遭到封鎖。
無 否 入口網站皆可檢視 將房價方案設為「公開」或「私人」。請參閱公開與不公開費率方案。 已啟用 否 - 設定房價方案的費用。請參閱設定費率方案的費用。
注意:不適用於可調整的通知方案。 - 如果所選產品套裝組合包含多個 API 產品,請在「特定或一般費率方案」部分中設定下列偏好設定:
注意:這個步驟不適用於可調整的通知方案。
欄位 說明 預設 逐一設定每項產品 此標記可指定是否要為每個 API 產品設定個別費率方案。 已停用 個別設定各項產品的免費增值方案 此標記可指定是否要為每個 API 產品設定免費增值方案。 已停用 選取產品 如果你啟用其中一或兩種標記,就必須在下拉式清單中選取各項產品,並設定費率方案詳細資料。 注意:請務必設定產品套裝組合中的所有產品。
無 - 根據所選費率方案類型設定費率方案詳細資料:
- 點選下列其中一個選項:
按鈕 說明 儲存為草稿 將費率方案儲存為草稿。 在你發布費率方案之前,應用程式開發人員不會看到費率方案。您可以編輯費率方案草稿中的任何欄位。
發布新方案 發布企劃書。 注意:發布費率方案後,如果結束日期尚未設定,就只能修改結束日期。費率方案一經發布即無法刪除,但可以過期,並以日後推出的費率方案取代,詳情請參閱「過期已發布的費率方案」一節。
- 請針對與費率方案涵蓋的 API 產品相關聯的 API Proxy,附加「營利限制檢查」政策。 「營利限制檢查」政策會強制執行 API Proxy 的營利限制,並確保擷取錯誤的 數據分析和營利報表若需更多資訊,請參閲 對 API Proxy 強制執行營利限制。
編輯費率方案
您可以編輯草稿費率方案中的所有欄位,但產品組合、類型和目標對象除外。發布費率方案後 您只能編輯結束日期,且必須在沒有指定結束日期的情況下才修改。
如何編輯費率方案:
- 前往費率方案頁面。
- 在要編輯的費率方案列中,按一下。
系統會隨即顯示費率方案面板。 - 視需要編輯費率方案欄位。
注意:發布費率方案後,如果結束日期尚未設定,就只能修改結束日期。 - 點選下列其中一個選項:
按鈕 說明 更新草稿 (草稿費率方案) 將費率方案儲存為草稿。
在你發布費率方案之前,應用程式開發人員不會看到費率方案。您可以編輯費率方案草稿中的任何欄位。發布草稿 (草稿費率方案) 發布費率方案。
注意:發布費率方案後,如果結束日期尚未設定,就只能修改結束日期。費率方案一經發布即無法刪除,但可以過期,並以日後推出的費率方案取代,詳情請參閱「過期已發布的費率方案」一節。更新後的結束日期 (已發布的房價方案) 為已發布的企劃書設定結束日期。
注意:已發布費率方案的結束日期一經設定即無法修改。
刪除草擬費率方案
刪除不再需要的草擬費率方案。
注意:你無法刪除已發布的費率方案。
如要刪除草稿費率方案,請按照下列步驟操作:
- 前往費率方案頁面。
- 將遊標移到上方 顯示要刪除的費率方案,即可顯示動作選單。
- 按一下「」。
- 按一下「刪除」來確認操作。
使用 API 管理費率方案
以下各節說明如何使用 API 管理費率方案。
使用 API 建立費率方案
如要建立費率方案,請向以下單位發出 POST 要求:
/organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
,
其中 {monetizationpackage_id}
是您要建立測試的 API 產品套裝組合 ID
費率方案 (當您建立 API 產品套裝組合時,系統會在回應中傳回此 ID)。
建立費率方案時,必須在要求主體中指定以下項目:
- 機構 ID
- API 產品組合 ID
- 房價方案的名稱
- 房價方案的說明
- 費率方案的範圍 (適用於所有開發人員,或僅適用於特定開發人員) 開發人員、公司或開發人員類別)
- 房價方案生效的日期
- 房價方案的幣別
- 是否發布房價方案
- 房價方案為公開或私人
您也可以視需要指定其他設定,例如付款的週期 到期 (例如 30 天)。請參閱費率方案的設定屬性。
如果您為 API 產品套裝組合建立費率方案 (不包括僅限費用方案),且 1 項產品,就可以將方案套用至產品套裝組合中的特定產品。做法是 識別要求中的產品如未認得產品,則可採用以下方案 會套用至 API 產品組合中的所有產品
以下各節說明如何建立房價方案:
使用 API 建立標準費率方案
如要建立標準費率方案,請將 type
屬性設為 STANDARD
。
如以下範例所示
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
使用 API 制定開發人員或公司費率方案
如要將房價方案套用至特定開發人員或公司,請將 type
值設為
Developer
。此外,您也必須識別要求中的開發人員或公司,
指明公司的 ID、法定名稱和開發人員名稱。
舉例來說,下列摘錄會建立 Dev Five
的費率方案
開發人員:
... "type": "DEVELOPER", "developer" : { "id" : "0mkKu1PALUGfjUph", "legalName" : "DEV FIVE", "name" : "Dev Five" } ...
使用 API 建立開發人員類別費率方案
如要將費率方案套用至開發人員類別,請將 type
值設為
Developer_Category
。此外,您也必須在要求中找出開發人員類別。
例如:
... "type": "DEVELOPER_CATEGORY", "developerCategory" : { "id" : "5e172299-8232-45f9-ac46-40076139f373", "name" : "Silver", "description" : "Silver category" } ...
使用 API 建立 API 產品專屬費率方案
建立含有多個 API 產品的 API 產品套裝組合費率方案時,你可以個別指定各 API 產品的費率方案詳細資料。
舉例來說,以下是包含兩項 API 產品的收益分潤方案:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Multi-product rate plan", "currency": { "id" : "usd" }, "description": "Multi-product rate plan", "displayName" : "Multi-product rate plan", "monetizationPackage": { "id": "mypackage", ... }, "organization": { "id": "{org_name}", ... }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":0, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product1","displayName":"Product1"}, "customPaymentTerm":false }, { "ratePlanRates":[{ "revshare":10, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product2","displayName":"Product2"}, "customPaymentTerm":false } ], "startDate": "2019-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \ -u email:password
如要將 API 產品新增至 my-package
API 產品套裝組合,請先新增
要求主體中的 API 產品費率方案詳細資料,如「將 API 產品新增至含有 API 產品專屬費率方案的 API 產品組合」一節所述。
ratePlanRates
陣列之外,這些值必須與費率方案中所有其他 API 產品指定的值一致。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "my-package_multi-product-rate-plan", "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":20, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "customPaymentTerm":false }] }] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \ -u email:password
使用 API 將費率方案設為公開或私人
建立費率方案時,你可以使用
isPrivate
屬性。如果設為 true
,表示費率方案
將設為私人。如需更多資訊,請參閱公開
而非私人費率方案
舉例來說,下列指令會建立不公開費率方案:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : true, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password