查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
簡介
在可調整的通知計畫中,API 供應商可以調整目標 每位應用程式開發人員的交易您可以設定是否傳送通知的依據以及通知時間 例如達到目標數字的百分比 例如 90%、100% 或 150%其他資訊 且在達到目標號碼後,就不會遭到封鎖。
使用 UI 設定可調整的通知計畫
如下所述,設定可調整的通知計畫。
Edge
如要使用 Edge UI 設定可調整的通知計畫,請在新增或編輯費率時 方案請選取「可調整的通知」費率方案類型,然後在「可調整的通知」部分中設定下列資訊:
欄位 | 說明 | 預設 |
---|---|---|
計算頻率 | 計算交易量 (或自訂屬性相關數量) 的期間。選取月數 (1 到 24 個月)。 | 1 個月 |
如果您已為 API 產品定義自訂屬性,您可以設定自訂評分參數,以便根據自訂屬性定義交易計數器。
例如:
- 根據 API 呼叫訊息中提供的值,向開發人員收取不固定的金額。
舉例來說,您可能想根據 API 要求中傳輸的位元組數,向應用程式開發人員收費。 - 將多個 API 呼叫組合為單一交易。
在這種情況下,請選取「使用自訂評分參數」,然後從下拉式清單中選取自訂屬性。
詳情請參閱使用自訂屬性設定費率方案。
傳統版 Edge (Private Cloud)
如要使用傳統版 Edge UI 設定可調整的通知計畫:
- 在「費率方案類型」中選取「可調整的通知」
] 欄位。
請參閱使用 UI 建立費率方案 一文,瞭解如何存取費率方案視窗。
- 將「續約效期」欄位設為方案的月數 會自動續訂 (除非開發人員在該日期前終止協議)。如果 如果您將這個值設為 0,計畫就會持續有效,直到開發人員選擇結束為止。
- 按一下「一般費率方案」下方的「詳情」。
- 將「匯總基礎」設為 交易匯總資料請選取介於 1 到 24 個月之間的數字。這個值的預設值為 1 每月。
- 按一下「套用並關閉」。
- 按一下「儲存草稿」。
- 請務必先確定企劃書已定案,再發布企劃書。參閱「發布費率方案」一文,瞭解
瞭解如何設定「發布日期」和「發布企劃書」
房價方案發布後,你只能修改結束日期。無法刪除房價 但可以過期並替換為未來費率方案 計劃中,過期的費率 計畫。
使用 API 設定可調整的通知計畫
在 ratePlanDetails
屬性中指定可調整的通知方案詳細資料
都會出現在 POST 要求中的
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
。
如要指定可調整的通知方案,請在 要求主體的 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 的交易次數
您可以在開發人員接受後,為應用程式開發人員設定目標交易次數 更新費率方案,之後可再更新。
設定接受費率方案時的目標交易次數
接受費率方案時,如要設定目標交易次數,請指定
對 POST 要求中的 quotaTarget
屬性提出要求
/organizations/{org_name}/developers/{developer_id}/developer-rateplans
資源。
將 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
在更新接受的費率方案時設定目標交易次數
如要設定目標交易次數,您可以更新已接受的費率方案,並指定
對 PUT 要求中要求主體中的 quotaTarget
屬性設定
/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
資源。將 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 }
或者,您也可以取得開發人員費率的 {developer-rateplan-id}
向管理員發出 GET 要求
/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
,
其中 {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":{ "id":"dev@<公司名稱>.com" },您好: "ratePlan":{ "id":"p1_adjustable-notification-plan" },您好: "startDate": "2016-04-15 00:00:00", "quotaTarget": 4000、 "suppress 警告":false" }」的錯誤訊息。 "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1" - U email:password