跳到主要内容

指南

集成概览:API、Webhook 和 Zapier

自动化与集成 · 阅读约 4 分钟

Mateflow 可以通过三种方式把你的社区连接到其他工具:已连接应用(Slack、Discord 和 Zapier)、发送到你自己服务器的 Webhook,以及面向开发者的 Open API。这三者都在同一个后台页面上:后台 → 设置 → 集成。

谁可以操作:所有者和管理员。 · 在哪里:网页端(站点后台)。 · 套餐:Webhook、API 访问以及每日 API 请求上限取决于你的平台套餐。

在站点后台中找到集成

前往后台 → 设置 → 集成。这个页面叫集成与 API,有四个标签页:

标签页 在这里可以做什么
集成 在已连接应用下连接 Slack、Discord 或 Zapier
Webhook 把社区事件发送到你自己的端点
API 访问 创建和撤销 API 密钥,打开开发者文档
投递日志 查看 Mateflow 向你的 Webhook、应用和自动化规则发出的每一个请求

连接 Slack、Discord 或 Zapier

已连接应用会把社区事件(例如新成员、帖子或付款)推送到其他服务:

  • Slack:通过 Incoming Webhook URL 向某个频道发送消息。
  • Discord:通过 Discord Webhook URL 向某个频道发送消息。它只发送消息,不同步成员或角色。
  • Zapier:把事件发送到 Zapier 的 Catch Hook,由 Zap 转发给数千个其他应用。

要连接其中一个,打开集成标签页,点击连接 Slack、连接 Discord 或连接 Zapier。粘贴该服务提供的 Webhook 地址,选择推送哪些事件,也可以添加签名密钥(可选),然后点击连接。接着点击发送测试事件,确认消息能够送达。

已连接的卡片会显示它正在推送哪些事件。通过卡片的菜单可以编辑设置、发送测试事件或断开连接。

用 Webhook 把事件发送到你自己的服务器

每当所选事件发生时,Webhook 会向你控制的端点发送一个 HTTPS 请求,例如会员加入、会员加入访问组、发布帖子或收到付款。每个 Webhook 都有自己的事件、可选的签名密钥,以及一个是否激活开关。能否使用 Webhook、可以创建多少个,取决于你的平台套餐。参见设置 Webhook。

用 Open API 构建你自己的集成

Open API 让开发者可以在自己的代码中读写你社区的数据:读取帖子、空间和成员,创建帖子,上传媒体,以及邀请他人。每个 API 密钥只属于一个社区,你在创建时选择它的权限(范围)。API 密钥不在创作者控制台(app.mateflow.com)中管理;控制台中社区的概览页面会链接到这个后台页面。

通过 API 发送的邀请可以包含访问组,对方接受邀请后就会获得这些访问组。参见访问组的工作原理。

完整的 API 参考位于 mateflow.com/developers。在 API 访问标签页中点击打开文档即可前往,然后把链接发给你的开发者;他们不需要在你的社区中拥有账号。参见创建 API 密钥。

在投递日志中查看发出的请求

投递日志标签页列出由你的 Webhook、已连接应用以及使用触发 Webhook 的自动化规则发出的请求。可以按事件类型、结果和日期筛选,点击查看详情可以看到完整的请求和响应。投递日志保留 30 天。投递失败的 Webhook 会自动重试;没有可以手动重新发送的按钮。

使用你的 API 密钥发出的请求不会记录在这里。API 访问标签页会显示每个密钥的最后使用日期。

相关文章

这篇指南对你有帮助吗?

返回指南列表

找不到所需的内容?

如果你是某个社区的成员,请联系该社区的管理员;如果你正在 Mateflow 上搭建或运营社区,我们的团队可以帮你。

免费开始