第 2 章 使用 Webhook 进行 3scale 自动化

Webhook 是一种有助于自动化的功能，也可用于根据 3scale 中发生的事件集成其他系统。当 3scale 系统中发生指定事件时，应用程序会收到 Webhook 信息。例如，通过配置 webhook，您可以使用新帐户注册的数据来填充开发人员门户。

2.1. Webhook 概述

Webhook 是一个自定义 HTTP 回调，它被从 Webhook 配置窗口中的可用事件选择来触发。发生这些事件时，3scale 系统会为 webhook 部分指定的 URL 地址生成 HTTP 或 HTTPS 请求。使用 Webhook，您可以将监听器配置为调用一些所需的行为，如事件跟踪。

Webhook 的格式始终相同。它使用以下结构的 XML 文档在端点中记录： 

<?xml version="1.0" encoding="UTF-8"?>
<event>
  <type>application</type>
  <action>updated</action>
  <object>
    THE APPLICATION OBJECT AS WOULD BE RETURNED BY A GET ON THE ACCOUNT MANAGEMENT
    API
  </object>
</event>

每个元素提供信息：

  • <type>:为您提供事件的主题，如应用、帐户 等等。
  • <action>:使用 更新、创建、删除 等值指定已完成的操作。
  • <object>:构成 XML 对象本身，其格式与帐户管理 API 返回的格式相同。要进行检查，您可以使用我们的互动 ActiveDocs。

如果您需要保证 3scale 发布 Webhook，请公开 HTTPS webhook URL，并在 3scale 中的 webhook 声明中添加自定义参数。例如： https://your-webhook-endpoint?someSecretParameterName=someSecretParameterValue。决定参数名称和值。然后，在 Webhook 端点中检查是否存在此参数值。