針對 API Proxy 強制執行營利限制

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

將「營利限制檢查」政策附加至 API Proxy,強制執行營利限制。 具體來說,在下列情況下會觸發政策:

  • 存取營利 API 的開發人員未註冊,或未訂閱費率方案。
  • 開發人員已超過訂閱費率方案的交易量。
  • 開發人員預付帳戶餘額或後付信用額度已達上限。

「營利限制檢查」政策的設計宗旨,是在發生上述情況時引發錯誤並封鎖 API 呼叫。這項政策會擴充 Raise Fault 政策 (請參閱「Raise Fault 政策」),您可以自訂傳回的訊息。適用條件是根據業務變數衍生而來。

使用 UI 附加營利限制檢查政策

如要強制執行營利限制,必須將營利限制檢查政策附加至 API Proxy 中存取 API 的要求流程。在要求中,任何 VerifyAPIKey 或 AccessTokenValidation 政策之後,都應附加 Monetization Limits Check 政策。

您可以在建立 API Proxy 時附加營利限制檢查政策,也可以在建立 API Proxy 後附加。

如「建構簡單的 API Proxy」一文所述,建立 API Proxy 時,如果已安裝營利功能,精靈中會顯示「營利」設定部分。

邊緣

在精靈的「Common policies」(常見政策) 頁面中,選取「Enforce monetization limits」(強制執行營利限制) 核取方塊,即可附加營利限制檢查政策。

營利限制檢查政策

請注意,精靈的「摘要」頁面會列出政策摘要。確認「營利」政策已列出,表示營利限制檢查政策會附加至 API Proxy,如下所述。

Classic Edge (Private Cloud)

在精靈的「安全性」頁面中,勾選「啟用營利限制檢查」核取方塊,即可附加營利限制檢查政策。

營利限制檢查政策

Monetization Limits Check 政策會新增至 ProxyEndpoint 要求 PreFlow,並位於 VerifyAPI Key 或 AccessTokenValidation 政策之後,如下圖所示。

如要將「營利限制檢查」政策新增至已建立的 API Proxy,請按照下列步驟操作:

  1. 在 API Proxy 編輯器中,按一下預設 Proxy 端點的「PreFlow」PreFlow
  2. 在「Request」流程中,點選「+Step」
  3. 在「中介服務」類別中選取「營利限制檢查」。

  4. 視需要修改「新增步驟」對話方塊中的欄位,然後按一下「新增」

這項政策會附加至任何 VerifyAPIKey 或 AccessTokenValidation 政策之後的要求流程,並強制執行從用戶端應用程式到 ProxyEndpoint PreFlow 的要求訊息。

如要進一步瞭解如何設定 MonetizationLimitsCheck 政策 XML 檔案,請參閱這篇文章