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

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

将创收限制检查政策附加到 API 代理,以强制执行创收限制。 具体而言,此政策会在以下条件下触发:

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

“创收限制检查”政策旨在引发错误,并在上述情况下阻止 API 调用。该政策扩展了“引发故障”政策(请参阅“引发故障”政策),并且您可以自定义返回的消息。适用的条件派生自业务变量。

使用界面附加创收限制检查政策

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

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

当您按照构建简单的 API 代理中的说明创建 API 代理时,如果安装了创收功能,向导中会显示创收配置部分。

Edge

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

创收限制检查政策

请注意,向导的 Summary 页面上汇总了策略。确保列出创收政策,指明创收限制检查政策将附加到 API 代理,如下所述。

传统 Edge (Private Cloud)

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

创收限制检查政策

在 VerifyAPI 密钥或 AccessTokenValidation 政策之后,代理端点请求 PreFlow 中添加了创收限制检查政策,如下图所示。

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

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

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

此政策将在完成任何 VerifyAPI 密钥或 AccessTokenValidation 政策之后附加到请求流,并将对从客户端应用发送到 ProxyEndpoint PreFlow 的请求消息强制执行。

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