第 4 章 使用 Webhook 的 3scale 自动化


Webhook 是一个有助于自动化的功能,也用于根据 3scale 中发生的事件集成其他系统。当在 3scale 系统中发生指定事件时,您的应用程序会收到 Webhook 消息通知。例如,通过配置 Webhook,您可以使用新帐户签名中的数据来填充 Developer Portal。

4.1. Webhook 概述

Webhook 是一个由 Webhook 配置窗口中可用事件选择的事件触发的自定义 HTTP 回调。当发生这些事件时,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> : 使用 updated, created, deleted 等值指定已进行了什么。
  • <object>:将 XML 对象本身视为与帐户管理 API 返回的格式相同。您可以使用我们的交互式 ActiveDocs 进行检查。

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

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.