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

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

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

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

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

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

如要強制執行營利限制,請務必在存取 API 的 API Proxy 中,將「營利限制檢查」政策附加至要求流程。請在要求中附加任何 VerifyAPIKey 或 AccessTokenValidation 政策後,再附加營利限制檢查政策。

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

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

Edge

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

「營利限制」檢查政策

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

Classic Edge (Private Cloud)

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

「營利限制」檢查政策

如下圖所示,系統會在 ProxyEndpoint 要求的 PreFlow 中,在 VerifyAPI Key 或 AccessTokenValidation 政策之後新增 Monetization Limits Check 政策。

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

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

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

這項政策會附加至任何 VerifyAPI Key 或 AccessTokenValidation 政策之後的請求流程,並套用至從用戶端應用程式傳送至 ProxyEndpoint PreFlow 的請求訊息。

如要進一步瞭解如何設定「MonetizationLimitsCheck」政策 XML 檔案,請參閱「MonetizationLimitsCheck 政策」。