您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
引言
在可調整的通知計畫中,API 供應商可為每位應用程式開發人員調整交易目標次數。您可以設定是否要根據達到目標數量的百分比 (例如 90%、100% 或 150%) 來決定是否傳送通知及傳送時間。達到目標號碼後,系統不會封鎖其他交易。
透過 UI 設定可調整的通知計畫
設定可調整的通知計畫,詳情請見下文。
Edge
如要使用 Edge UI 設定可調整的通知方案,請在新增或編輯費率方案時選取「Adjustable Notification」費率方案類型,然後在「Adjustable Notification」部分設定下列資訊:
欄位 | 說明 | 預設 |
---|---|---|
計算頻率 | 計算交易量 (或自訂屬性相關量) 的時間範圍。選取月數 (1 至 24 個月)。 | 1 個月 |
如果您已為 API 產品定義自訂屬性,可以設定自訂評分參數,根據自訂屬性定義交易計數器。
舉例來說,您可能需要:
- 根據 API 呼叫訊息中提供的值,向開發人員收取變動金額。
舉例來說,您可能會想根據 API 要求中傳輸的位元組數,向應用程式開發人員收費。 - 將多個 API 呼叫納入單筆交易中。
在此情況下,請選取「使用自訂評分參數」,然後從下拉式清單中選取自訂屬性。
詳情請參閱使用自訂屬性設定費率方案。
傳統邊緣 (Private Cloud)
如何使用傳統版 Edge UI 設定可調整的通知計畫:
- 前往「費率方案」視窗,在「方案詳細資料」分頁的「費率方案類型」欄位中,選取「可調整通知」。
如要瞭解如何存取「費率方案」視窗,請參閱「使用 UI 建立費率方案」一文。
- 將「續約效期」欄位設為方案自動續約的月數 (除非開發人員在協議日期前終止協議)。如果將這個值設為 0,方案會一直有效,直到開發人員選擇結束方案。
- 按一下「一般費率方案」下方的「詳細資料」。
- 將「匯總基礎」設為匯總交易次數的時間範圍。選取介於 1 到 24 個月之間的數字。這個值預設為 1 個月。
- 按一下「套用並關閉」。
- 按一下「儲存草稿」。
- 只有在確定企劃書最終定案時再發布企劃書。如要瞭解如何設定「發布日期」及發布方案,請參閱「發布費率方案」。
發布費率方案後,就只能修改結束日期。費率方案發布後即無法刪除,但您可以到期費率方案,並替換為未來的費率方案,詳情請參閱「過期的費率方案」。
使用 API 設定可調整的通知計畫
在傳送給 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans
的 POST 要求中,透過 ratePlanDetails
屬性指定可調整的通知方案詳細資料。
如要指定可調整的通知方案,請在要求主體的 ratePlanDetails 中指定下列值:
屬性 | 值 |
---|---|
type |
請設為 USAGE_TARGET 。 |
meteringType |
請設為 DEV_SPECIFIC 。 |
duration |
請設為匯總依據的時間,加上 durationType 。如為可調整通知費率方案,請將該值設為介於 1 至 24 之間的整數值。 |
durationType |
請設為匯總依據的時間,加上 |
如要進一步瞭解可在指定可調整通知方案詳細資料時,可設定的設定屬性,請參閱「費率方案詳細資料配置設定」。
舉例來說,下列程式碼定義了可調整的通知計畫,匯總方式設為 1 個月。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "AdjustableNotification", "displayName": "Adjustable notification plan", "description": "Adjustable notification plan", "published": "true", "organization": { "id": "myorg" }, "startDate": "2016-04-15 00:00:00", "type": "STANDARD", "monetizationPackage": { "id": "p1", "name": "test" }, "currency": { "id" : "usd", "name" : "USD" }, "ratePlanDetails": [ { "type": "USAGE_TARGET", "meteringType": "DEV_SPECIFIC", "duration": 1, "durationType": "MONTH", "ratingParameter": "VOLUME", "organization": { "id": "myorg" }, "currency": { "id": "usd", "name": "USD" } } ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans" \ -u email:password
使用 API 為每位應用程式開發人員設定目標交易次數
您可以在開發人員接受費率方案後,設定該應用程式的開發人員目標交易次數,日後您可以更新這個值。
接受費率方案時設定交易目標次數
接受費率方案時,如要設定交易目標數,請在向 /organizations/{org_name}/developers/{developer_id}/developer-rateplans
資源的 POST 要求中,指定 quotaTarget
屬性。將 quotaTarget
設為正整數或 0,即可停用應用程式開發人員的通知。如未指定,quotaTarget 預設為 0。
舉例來說,當應用程式開發人員接受可調整通知方案時,下列要求會將交易目標次數設為 4000。
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "developer":{ "id":"dev@mycompany.org" }, "ratePlan":{ "id":"p1_adjustable-notification-plan" }, "startDate": "2016-03-24 00:00:00", "quotaTarget": 4000, "suppressWarning": false }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
更新已接受的費率方案時,設定交易目標次數
如要設定目標交易次數,您可以更新系統接受的費率方案,並透過向 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
資源的 PUT 要求要求主體中指定 quotaTarget
屬性。將 quotaTarget
設為正整數或 0,即可停用應用程式開發人員的通知。如未指定,quotaTarget 預設為 0。
如果您接受已發布的費率方案,回應中會傳回 {developer_rateplan_id}
。
例如:
{ "created": "2016-03-31 18:59:54", "developer": { ... }, "id": "b1c600b8-f871-496d-8173-12b9950d6ab1", "quotaTarget": 3000, "ratePlan": { ... }, "startDate": "2016-03-31 00:00:00", "updated": "2016-03-31 18:59:54", "waiveTerminationCharge": false }
或者,您也可以向 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
發出 GET 要求,取得開發人員費率方案的 {developer-rateplan-id}
,其中 {developer_id}
是開發人員的電子郵件地址。詳情請參閱「查看開發人員接受的所有費率方案」。
例如:
{ "developerRatePlan": [ { "created": "2016-03-31 14:52:30", "developer": { ... }, "id": "b1c600b8-f871-496d-8173-12b9950d6ab1", "quotaTarget": 3000, "ratePlan": { ... }, "startDate": "2016-03-31 00:00:00", "updated": "2016-03-31 18:59:54" } ], "totalRecords": 1 }
以下要求將目標交易次數更新為 4000。
$ curl -H "Content-Type:application/json" -X PUT -d \ '{ "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1", "developer":, application/json" -X PUT -d \ '{ "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1", "developer":, 2020 年 4 月 11 日 email:password