您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
瀏覽費率方案頁面
前往房價方案頁面,如下所述。
Edge
如要在 Edge UI 中查看費率方案,請前往「費率方案」頁面:
- 登入 apigee.com/edge。
- 在左側導覽列中,依序選取「發布」>「營利」>「費率方案」。
系統隨即會顯示「費率方案」頁面。
如上圖所示,「費率方案」頁面可讓您:
傳統邊緣 (Private Cloud)
如要使用傳統版 Edge UI 查看費率方案,請前往「API 套件」頁面:
- 登入
http://ms-ip:9000
,其中 ms-ip 是管理伺服器節點的 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 建立費率方案
如要建立費率方案,請向 /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
發出 POST 要求,其中 {monetizationpackage_id}
是您建立費率方案的 API 產品套裝組合 ID (在您建立 API 產品套裝組合時,會在回應中傳回該 ID)。
建立費率方案時,您必須在要求主體中指定以下內容:
- 機構 ID
- API 產品組合 ID
- 房價方案名稱
- 費率方案說明
- 費率方案的範圍 (是否適用於所有開發人員,或只適用於特定開發人員、公司或開發人員類別)
- 房價方案生效日期
- 房價方案幣別
- 是否發布房價方案
- 房價方案為公開或不公開
您也可以視需要指定其他設定,例如付款到期期間 (例如 30 天)。請參閱費率方案的設定屬性。
如要為含有多項產品的 API 產品套裝組合建立費率方案 (僅限費用方案),可以將方案套用至產品組合中的特定產品。方法很簡單,只要在要求中識別產品即可。如未找到任何產品,方案會套用至 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 產品組合。
$ 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
使用 API 發布費率方案
如要發布費率方案,請在建立房價方案時將 published
屬性值設為 true。開發人員將可查看方案的 startDate
屬性指定日期起的費率方案。
舉例來說,下列指令會建立並發布價目表方案 (只顯示要求的部分內容):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "true", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
使用 API 儲存費率方案草稿
如要儲存但不發布費率方案,請在建立房價方案時,將 published
屬性值設為 false。
舉例來說,下列指令會建立價目表方案,並儲存為草稿 (只顯示要求的一部分):
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "false", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
使用 API 編輯費率方案草稿
如要更新費率方案草稿,請向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}
發出 PUT 要求,其中 {package_id}
是 API 套件的識別名稱,{plan_Id}
則是費率方案的識別資料。更新時,您必須在要求主體中指定更新的設定和費率方案的 ID。如果更新費率方案,您也必須指定費率方案的 ID。舉例來說,下列要求會更新 ID 為 location_flat_rate_card_plan
(醒目顯示更新) 的房價方案費率:
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "location_flat_rate_card_plan", "name": "Flat rate card plan", "advance": "false", "currency": { "id" : "usd" }, "description": "Flat rate card plan", "displayName" : "Flat rate card plan", "frequencyDuration": "30", "frequencyDurationType": "DAY", "earlyTerminationFee": "10", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": "false", "published": "false", "ratePlanDetails": [ { "currency": { "id" : "usd" }, "paymentDueDays": "30", "meteringType": "UNIT", "organization": { "id": "{org_name}" }, "ratePlanRates": [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "type": "RATECARD", "rate": "0.15", "startUnit": "0" } ], "ratingParameter": "VOLUME", "type": "RATECARD" }], "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/location_flat_rate_card_plan" \ -u email:password
回應中會包含更新後的費率方案費率 (只有回覆部分顯示):
… "ratePlanRates" : [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "rate" : 0.15, "startUnit" : 0, "type" : "RATECARD" } ], …
使用 API 查看費率方案
您可以按照下列各節所述,使用營利 API 查看費率方案。
- 使用 API 查看機構的所有費率方案
- 使用 API 查看 API 產品套裝組合的所有費率方案
- 使用 API 查看 API 產品套裝組合費率方案
- 使用 API 查看開發人員適用的所有有效費率方案
- 使用 API 查看開發人員認可的費率方案
- 查看已接受的費率方案,適用於使用 API 產品的 API 產品
- 查看開發人員使用 API 接受的所有房價方案
使用 API 查看機構的所有費率方案
如要查看機構的所有費率方案,請向 /mint/organizations/{org_name}/rate-plans
發出 GET 要求,其中 {org_name}
是貴機構的名稱。
您可以傳遞下列查詢參數來篩選結果:
查詢參數 | 說明 |
---|---|
all |
這個旗標用於指定是否要傳回所有房價方案。如果設為 false ,每頁傳回的房價方案數量則由 size 查詢參數定義。預設值為 true 。 |
size |
每頁傳回的 API 套件數量。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
page |
您要傳回的網頁數 (如果內容分頁)。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
使用 API 查看 API 產品套裝組合的所有費率方案
如要查看特定 API 套件的所有費率方案,請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
發出 GET 要求,其中 {package_id}
是 API 套件的 ID (當您建立營利套件時,系統會傳回套件 ID)。
根據預設,結果中只會傳回有效、公開和標準費率方案。如何加入:
- 草稿或過期的房價方案,請將
current
查詢參數設為false
(例如?current=false
)。 - 不公開費率方案,請將
showPrivate
查詢參數設為true
(例如?showPrivate=true
)。 - 所有標準費率方案,請將
standard
查詢參數設為true
(例如?standard=true
)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
使用 API 查看 API 套件的費率方案
如要查看 API 套件的費率方案,請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}
發出 GET 要求,其中 {package_id}
是 API 套件的 ID,{plan_id}
則是費率方案的 ID (系統會在您建立營利套裝方案時傳回套件 ID,並在您建立費率方案時傳回費率方案 ID)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
以下提供回應範例:
{ "advance" : true, "contractDuration" : 1, "contractDurationType" : "YEAR", "currency" : { "id" : "usd", ... "organization" : { ... }, ... }, "description" : "Standard Fixed Plan", "displayName" : "Standard Fixed Plan", "earlyTerminationFee" : 0.0000, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "communications_standard_fixed_plan", "isPrivate" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Standard Fixed Plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : true, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2", "rate" : 0.0500, "startUnit" : 0, "type" : "RATECARD" } ], "ratingParameter" : "VOLUME", "type" : "RATECARD" } ], "recurringFee" : 200.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 100.0000, "startDate" : "2013-01-11 22:00:00", "type" : "STANDARD" }
使用 API 查看開發人員適用的所有有效費率方案
如要查看開發人員的所有有效費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans
發出 GET 要求,其中 {developer_id}
是開發人員的電子郵件地址。
您可以傳遞下列查詢參數來篩選結果:
查詢參數 | 說明 |
---|---|
all |
指定是否要傳回所有 API 套件的旗標。如果設為 false ,每個頁面傳回的 API 套件數量則由 size 查詢參數定義。預設值為 false 。 |
size |
每頁傳回的 API 套件數量。預設值為 20。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
page |
您要傳回的網頁數 (如果內容分頁)。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
以下提供回應範例:
{ "ratePlan" : [ { "advance" : true, "contractDuration" : 1, "contractDurationType" : "MONTH", "currency" : { "description" : "United States Dollar", "displayName" : "United States Dollar", "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Fee Only RatePlan", "displayName" : "Fee Only RatePlan", "earlyTerminationFee" : 10.0000, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "WEEK", "id" : "messaging_package_fee_only_rateplan", "isPrivate" : false, "monetizationPackage" : { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, "name" : "Fee Only RatePlan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ ], "recurringFee" : 10.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 20.0000, "startDate" : "2013-02-20 00:00:00", "type" : "STANDARD" } ], "totalRecords" : 1 }
使用 API 查看開發人員接受的費率方案
如要查看開發人員的有效費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
發出 GET 要求 (其中 {developer_id}
是開發人員的電子郵件地址),而 {developer_rateplan_id}
是在您接受已發布的費率方案時,回應中系統傳回的費率方案 ID。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
以下提供回應範例:
{ "created" : "2018-01-25 20:01:54", "developer" : { }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }
查看已接受的費率方案,適用於使用 API 產品的 API 產品
如要查看含有 API 產品的開發人員接受的費率方案,請向 /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product
發出 GET 要求,其中 {developer_id}
是開發人員的 ID,/{product_id}
是產品的 ID。
根據預設,結果只會傳回公開費率方案。如要顯示不公開費率方案,請將 showPrivate
查詢參數設為 true
(例如 ?showPrivate=true
)。
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
查看開發人員使用 API 接受的所有費率方案
如要查看開發人員已接受的費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
發出 GET 要求,其中 {developer_id}
是開發人員 ID。
您可以傳遞下列查詢參數來篩選結果:
查詢參數 | 說明 |
---|---|
all |
指定是否要傳回所有 API 套件的旗標。如果設為 false ,每個頁面傳回的 API 套件數量則由 size 查詢參數定義。預設值為 false 。 |
size |
每頁傳回的 API 套件數量。預設值為 20。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
page |
您要傳回的網頁數 (如果內容分頁)。如果將 all 查詢參數設為 true ,系統就會忽略這個參數。 |
例如:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
以下提供回應範例:
{ "developerRatePlan" : [ { "created" : "2018-01-25 20:01:54", "developer" : { ... }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }], "totalRecords" : 1 }
使用 API 刪除費率方案草稿
如要刪除費率方案草稿,請向 /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}
發出 DELETE 要求,其中 {plan_Id}
是要刪除的費率方案識別,{package_id}
則是費率方案的 API 套件識別項。例如:
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
費率方案的設定屬性
使用 API 建立費率方案時,您可以指定下列配置設定,
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
advance |
僅適用於週期性費用,指定是否預先收取週期性費用的標記。有效值包括:
|
false | 否 |
contractDuration |
搭配 |
不適用 | 否 |
contractDurationType |
搭配
|
不適用 | 否 |
currency |
房價方案使用的貨幣。指定貨幣的 ISO 4217 代碼,例如用 |
不適用 | 是 |
description |
費率方案的說明。 |
不適用 | 是 |
developer |
開發人員 ID (電子郵件地址)。僅適用於開發人員費率方案。 |
不適用 | 否 |
developerCategory |
開發人員類別 ID。僅用於指定開發人員類別費率方案。 |
不適用 | 否 |
displayName |
使用者容易理解的房價方案顯示名稱。 |
不適用 | 是 |
earlyTerminationFee |
如果開發人員在續約期限前結束方案,則需要支付一次性費用。 |
不適用 | 否 |
endDate |
方案結束日期。上述日期過後,開發人員便無法查看費率方案。如果不想讓費率方案在特定日期結束,請為 房價方案的效期至指定日期的當天結束為止。舉例來說,如果您想讓費率方案在 2016 年 12 月 1 日到期,請將 endDate 值設為 2016-11-30。在這種情況下,費率方案將於 2016 年 11 月 30 日當天結束前到期,且 2016 年 12 月 1 日的所有要求都會遭到封鎖。 注意:使用 API 查看費率方案時,系統會將 endDate 時間戳記指定為 |
不適用 | 否 |
freemiumDuration |
與 |
不適用 | 否 |
freemiumDurationType |
與
|
不適用 | 否 |
freemiumUnit |
免費增值數量。這個值可以是交易次數,或是交易記錄政策中記錄的自訂屬性相關單位數量。 |
不適用 | 否 |
frequencyDuration |
僅適用於週期性費用,週期性費用與「 |
不適用 | 否 |
frequencyDurationType |
僅適用於週期性費用,週期性費用與「frequencyDuration 」之間的時間間隔。有效值包括:
|
不適用 | 否 |
isPrivate |
指定費率方案為公開或不公開的旗標。預設值為 false (公開)。詳情請參閱公開與不公開費率方案。 |
不適用 | 否 |
monetizationPackage |
費率方案的 API 產品組合 ID。 |
不適用 | 否 |
name |
費率方案的名稱。 |
不適用 | 是 |
organization |
房價方案的機構 ID。 |
不適用 | 是 |
paymentDueDays |
僅適用於週期性費用,費用的到期天數。例如,將這個值設為 30,表示費用將在 30 天內到期。 |
不適用 | 否 |
proRate |
僅適用於週期性費用,此標記用於指定在開發人員開始或結束方案整個月時,是否會按比例計算週期性費用。有效的值包括:
|
false | 否 |
published |
此標記用於指定是否要發布費率方案以供開發人員查看。有效值包括:
|
不適用 | 是 |
ratePlanDetails |
費率方案的詳細資料 (請參閱費率方案詳細資料的設定屬性)。 |
不適用 | 是 |
recurringFee |
在開發人員結束方案前,持續向開發人員收取費用。 |
不適用 | 否 |
recurringStartUnit |
只有在 |
不適用 | 否 |
recurringType |
安排週期性費用,有效值包括:
|
不適用 | 否 |
setUpFee |
在方案開始日期 (即開發人員購買方案的日期) 當天,系統會向每位開發人員收取一次性費用。 |
不適用 | 否 |
startDate |
方案開始日期。開發人員可查看自該日起的費率方案。 |
不適用 | 是 |
type |
房價方案類型。請指定下列其中一項:
|
不適用 | 是 |
費率方案詳細資料的設定屬性
建立費率方案時,您可以在 ratePlanDetails
陣列中指定下列任一設定屬性。
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
aggregateFreemiumCounters |
這個旗標用於指定是否要啟用匯總計數器,以便判斷 API 產品的用量是否在免費範圍內。您必須啟用匯總計數器,才能為產品設定免費增值方案。有效值包括:
|
不適用 | 否 |
aggregateStandardCounters |
指定是否要使用匯總計數器來判斷用量頻帶 (例如價目表方案的音量帶) 的標記。這個值可以是下列其中一項:
|
不適用 | 否 |
aggregateTransactions |
注意:這個屬性目前不用於營利,可忽略。 |
true | 否 |
currency |
Currency (貨幣) |
不適用 | 否 |
duration |
計算頻率的期間加上 舉例來說,您可以將 |
不適用 | 否 |
durationType |
計算頻率的時段,加上 如需使用範例,請參閱 |
不適用 | 否 |
freemiumDuration |
個別 API 產品的免費增值期與 |
不適用 | 否 |
freemiumDurationType |
個別 API 產品的免費增值期與
舉例來說,如要將 API 產品的免費增值期指定為 30 天,請將 |
不適用 | 否 |
freemiumUnit |
API 產品的免費增值數量。這個值可以是交易次數,或是交易記錄政策中記錄的自訂屬性相關單位數量。 |
不適用 | 否 |
meteringType |
價目表方案的充電模式。有效值包括:
|
不適用 | 是 |
organization |
機構 ID |
不適用 | 否 |
paymentDueDays |
後付開發人員的付款截止日。例如,將這個值設為 30,表示付款期限為 30 天。 |
不適用 | 否 |
product |
API 產品資訊,例如 ID。 |
不適用 | 否 |
ratePlanRates |
費率方案費率詳細資料,例如費率方案類型 ( |
不適用 | 是 |
ratingParameter |
費率方案的基底。費率方案是以交易或自訂屬性為基礎。有效值包括:
|
VOLUME |
是 |
ratingParameterUnit |
適用於 |
不適用 | 是 |
revenueType |
在收益分潤方案中,收益分潤的要點。有效值包括:
|
不適用 | 否 |
type |
房價方案類型。有效值包括:
如要進一步瞭解費率方案類型,請參閱「支援的費率方案類型」。 |
不適用 | 是 |