API 密钥让开发者或你运行的工具可以通过 Mateflow Open API 读写你社区的数据。你可以在后台 → 设置 → 集成 → API 访问中创建和撤销 API 密钥。每个密钥只对一个社区有效。
谁可以操作：所有者和管理员。 · 在哪里：网页端（站点后台）。 · 套餐：能否使用 API 访问，以及社区每天可以发出多少个 API 请求，取决于你的平台套餐。
API 密钥按社区分别创建
API 密钥只属于一个社区，用某个密钥发出的请求始终作用于这个社区。要连接多个社区，请在每个社区各自的站点后台中分别创建密钥。
创作者控制台（app.mateflow.com）中没有 API 密钥。那里原来的工作区级密钥已经由按社区创建的密钥取代。控制台中社区的概览页面会链接到该社区的集成页面。
创建 API 密钥
- 前往后台 → 设置 → 集成，打开 API 访问标签页。
- 点击生成新密钥。
- 输入能说明用途的密钥名称，例如将要使用它的工具。
- 在作用域与权限下，只勾选集成需要的权限。参见下一节。
- 可选：在 IP 白名单 (可选) 下，输入允许使用这个密钥的 IP 地址或地址段，用英文逗号分隔。
- 点击生成新密钥。
- 在 API 密钥已生成中复制密钥，把它存放在安全的地方，然后点击完成。
完整的密钥只显示一次。如果丢失了，请生成一个新密钥，并撤销旧密钥。
如果 API 访问标签页显示升级提示，说明你的平台套餐不包含 API 访问。API 端点卡片会显示请求的基础 URL，以及你的套餐每天的请求上限，该上限在 UTC 时间 00:00 重置。
API 密钥的作用域（权限）
| 作用域 | 允许的操作 |
|---|---|
| 读取社区 | 读取社区资料、设置和元数据 |
| 读取内容 | 读取帖子、动态、回复和搜索结果 |
| 写入内容 | 创建、编辑和删除帖子与回复 |
| 上传媒体 | 申请上传令牌；也包括读取带签名的媒体 URL |
| 读取媒体 | 读取现有媒体的签名 URL |
| 读取空间 | 列出空间并读取空间详情 |
| 读取成员 | 查找成员并读取基本资料，包括他们所属的访问组 |
| 邀请成员 | 通过邮箱或邀请链接邀请他人 |
读取成员和邀请成员列在敏感权限下。读取成员让集成可以检查某个邮箱地址是否属于你的社区。使用邀请成员时，除非集成指定了其他邀请人，否则邀请会以社区所有者的名义发出；受邀的人始终以成员身份加入。通过 API 发送的邀请可以包含访问组。参见访问组的工作原理。
密钥的作用域之后无法更改。较早的密钥可能显示全部（旧版）：它们只保留创建时已存在的作用域。要使用较新的作用域，请创建一个新密钥。
撤销 API 密钥
- 在 API 访问标签页中，在 API 密钥列表下找到这个密钥。
- 打开它的操作菜单，点击撤销密钥。
- 确认。撤销后无法恢复，所有使用这个密钥的工具都会停止工作。
列表会显示每个密钥的状态（有效、已过期或已吊销）和最后使用日期。API 请求不会出现在投递日志中，所以要通过最后使用来判断某个密钥是否仍在使用。断开 Slack、Discord 或 Zapier 的连接不会撤销任何 API 密钥。
保护好 API 密钥
- 把 API 密钥放在服务器上，不要放进别人可以下载的网站或 App 中，并通过 HTTPS 发送请求。
- 为每个工具单独创建一个密钥，只授予它需要的作用域，这样撤销其中一个时不会影响其他工具。
- 如果工具从固定的地址发起调用，请添加 IP 白名单。
- 如果密钥可能已经泄露，请立即撤销，然后创建一个替代密钥。
在哪里找到 API 文档
API 参考涵盖端点、请求和响应格式、作用域、错误码和代码示例。在 API 访问标签页中，开发者文档卡片上有一个打开文档按钮，可以前往 mateflow.com/developers。把这个链接发给你的开发者。他们不需要在你的社区中拥有账号；即使你的套餐不包含 API 访问，这个页面也可以访问。
相关文章
这篇指南对你有帮助吗？