对 API 代理强制执行创收限制

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

将 MonetizationLimitsCheck 政策附加到 API 代理,以强制执行创收限制。 具体而言,当满足以下条件时,系统会触发此政策:

  • 访问创收 API 的开发者未注册或未订阅费率方案。
  • 开发者已超出所订阅费率方案的交易量上限。
  • 开发者预付费账号余额或后付费信用额度已达到上限。

MonetizationLimitsCheck 政策旨在针对上述情况引发故障并阻止 API 调用。该政策扩展了 Raise Fault 政策(请参阅 Raise Fault 政策),您可以自定义返回的消息。适用的条件派生自业务变量。

使用界面附加 MonetizeLimitsCheck 政策

如需强制执行创收限制,必须将 MonetizationLimitsCheck 政策附加到访问您的 API 的 API 代理中的请求流。应在请求中的任何 VerifyAPIKey 或 AccessTokenValidation 政策后面附加创收限制检查政策。

您可以在创建 API 代理时或创建 API 代理后附加“创收限制检查”政策。

在您创建 API 代理(如构建简单的 API 代理中所述)时,如果已安装创收功能,向导中会显示“创收配置”部分。

Edge

在向导的常用政策页面上,选中强制执行创收限制复选框,以附加 MonetizationLimitsCheck 政策。

MonetizationLimitsCheck 政策

请注意,在向导的“摘要”页面上,系统会汇总政策。确保列出了“创收”政策,表明 MonetizationLimitsCheck 政策将附加到 API 代理,如下所述。

传统边缘(私有云)

在向导的安全页面上,选中启用创收限制检查复选框,以附加“创收限制检查”政策。

MonetizationLimitsCheck 政策

MonetizeLimitsCheck 政策会添加到 ProxyEndpoint 请求 PreFlow 中,位于 VerifyAPIKey 或 AccessTokenValidation 政策之后,如下图所示。

如需将 MonetizationLimitsCheck 政策添加到已创建的 API 代理,请执行以下操作:

  1. 在 API 代理编辑器中,点击默认代理端点的 PreFlow
  2. 在“请求”流程中,点击 + 步骤
  3. 在“中介”类别中,选择“创收限制检查”。

  4. 根据需要修改“添加步骤”对话框中的字段,然后点击添加

该政策会在任何 VerifyAPIKey 或 AccessTokenValidation 政策之后附加到请求流,并会对客户端应用发送到 ProxyEndpoint PreFlow 的请求消息强制执行。

如需详细了解如何配置 MonetizationLimitsCheck 政策 XML 文件,请参阅 MonetizationLimitsCheck 政策