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

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

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

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

「營利限制檢查」政策旨在發出錯誤,並在上述情況中封鎖 API 呼叫。這項政策會擴充「提報錯誤」政策 (請參閱提報錯誤政策),您可以自訂傳回的訊息。適用條件衍生自業務變數。

透過使用者介面附加營利限制檢查政策

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

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

按照「建立簡易 API Proxy」一節的說明建立 API Proxy。如果您已安裝營利功能,精靈中會顯示「營利」設定部分。

Edge

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

營利限制檢查政策

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

傳統邊緣 (Private Cloud)

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

營利限制檢查政策

如下圖所示,在 ProxyEndpoint 要求 PreFlow 中加入營利限制檢查政策,如下圖所示。

如要為已建立的 API Proxy 新增營利限制檢查政策:

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

  4. 視需要修改「Add Step」對話方塊中的欄位,然後按一下「Add」

這項政策會在任何 VerifyAPI 金鑰或 AccessTokenValidation 政策之後附加至要求流程,並會在用戶端應用程式傳送至 ProxyEndpoint PreFlow 的要求訊息時強制執行。

如要進一步瞭解如何設定 MonetizeLimitsCheck 政策 XML 檔案,請參閱 MonetizeLimitsCheck 政策