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

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

将“获利限制检查”政策附加到 API 代理,以强制执行获利限制。 具体而言,在以下情况下会触发此政策:

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

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

使用界面附加 Monetization Limits Check 政策

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

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

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

Edge

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

创收限制检查政策

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

经典边缘(私有云)

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

创收限制检查政策

Monetization Limits Check 政策会添加到 ProxyEndpoint 请求 PreFlow 中,位于 VerifyAPI Key 或 AccessTokenValidation 政策之后,如下图所示。

如需将“创收限制检查”政策添加到已创建的 API 代理,请执行以下操作:

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

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

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

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