协作密钥

概述

协作密钥允许您为外部协作者（合作伙伴、客户、其他内部系统等）签发专用 API 密钥来调用您的端点。每个协作密钥可以独立配置：

• 专用 API 密钥（沙盒环境 / 生产环境各 1 对，创建时立即签发）
• CRUD 权限 — Create (POST) / Read (GET) / Update (PUT) / Delete (DELETE)
• 激活 / 停用 切换 — 立即拦截特定协作者
• 邮件邀请 — 向单个密钥邀请多个协作者

什么时候需要？

• 与多个合作伙伴共享端点，想要追踪各方的调用量
• 想要给特定合作伙伴仅读取（GET）权限
• 需要因问题仅停止某个合作伙伴的调用
• 合作伙伴的开发者需要访问测试页面和集成指南

一个密钥，多个协作者

单个协作密钥可以邀请多个协作者。通常用于"每家公司 1 个密钥 → 邀请该公司的联系人"。

如何进入

1. 顶部菜单 APIs → 点击端点名称进入端点详情
2. 在协作密钥区域点击 查看全部 按钮

---

协作密钥列表

所有已注册的协作密钥以表格形式显示。

列	说明
序号	行号
名称	协作密钥名称（例如合作伙伴名称）
描述	用途描述
邀请	邀请状态。X 人已接受，Y 人待处理 格式
沙盒环境	沙盒环境 API 密钥激活/停用标签
生产环境	生产环境 API 密钥激活/停用标签
创建时间	协作密钥创建时间

点击顶部的 添加 按钮注册新密钥。点击表格中的名称进入详情页。

添加协作密钥

点击 添加 打开对话框。此步骤是创建协作 API 密钥——邀请协作者在之后的详情页进行。

输入字段

• 协作密钥名称 — 必填。输入可区分的名称，如合作伙伴或团队名称（例如 Acme Corp、Mobile Team）
• 描述 — 可选。简要说明用途
• 权限 — 选择该密钥允许执行的 API 操作
  • Create (POST) / Read (GET) / Update (PUT) / Delete (DELETE)
  • 默认全部选中。仅勾选需要的即可

保存后将立即签发沙盒环境和生产环境 API 密钥，然后跳转到详情页。

协作密钥详情

单个协作密钥的所有管理在此页面完成。

API 密钥

顶部有 沙盒环境 | 生产环境 标签页，独立管理各环境的 API 密钥。

• API 密钥显示：提供隐藏、复制和重新生成按钮
• 激活/停用切换（电源图标）：切换为停用后，该环境中使用此密钥的所有 API 调用立即被拒绝。用于临时拦截特定协作者
• 重新生成：旧密钥立即失效并签发新密钥。请务必通知协作者密钥已更换

权限

指定该协作密钥可以执行的 API 操作。

• Create (POST) / Read (GET) / Update (PUT) / Delete (DELETE) 复选框
• 更改后点击 保存
• 调用无权限的方法返回 403 Forbidden
• 权限按环境独立管理，因此可以在沙盒环境中允许广泛访问，在生产环境中进行限制

邀请

管理与该协作密钥关联的协作者邀请。

发送邀请

点击 邀请协作者 按钮打开对话框。输入协作者的邮箱地址后发送。

• 向协作者发送邀请邮件
• 协作者登录后，仪表盘顶部也会显示邀请接受横幅
• 邀请有效期 7 天 — 过期后需要重新发送

按邀请状态的操作

状态	操作按钮
待处理	取消邀请、重新发送
已接受	撤销访问
已过期	重新发送

协作者接受后可以做什么

• 在仪表盘上查看共享端点
• 查看已签发的 API 密钥（沙盒环境 / 生产环境）
• 在测试与集成指南页面测试（Swagger 风格，curl/JS/Python 示例）
• 查看端点的日志和统计
• 配置分配给自己的通知

协作者不能做的事：更改端点设置、管理其他协作者、直接部署到生产环境（只能请求）。

撤销访问的注意事项

• 撤销邀请会断开协作者的仪表盘访问权限
• 要使 API 密钥本身失效，请使用激活/停用切换或重新生成
• 要完全拦截访问，请同时执行"撤销访问 + 停用密钥（或重新生成）"

危险区域

• 删除协作密钥 — 完全移除该协作密钥
• 所有环境的 API 密钥、关联邀请和权限设置均被删除
• 使用该密钥的所有 API 调用立即停止
• 该密钥的历史 API 调用记录（日志）保留，但不再接收新调用

---

常见问题

• 协作者未收到邀请邮件：请检查垃圾邮件文件夹。仍未找到的话，在状态为待处理时点击 重新发送
• 接受链接显示已过期：7 天有效期。使用 重新发送 发送新链接
• 想要临时拦截特定协作者：在协作密钥详情页点击 API 密钥停用切换。调用立即被拦截，重新激活后恢复
• 沙盒环境正常但生产环境被拒绝：权限按环境独立管理。请检查生产环境标签页是否勾选了 CRUD 权限
• 重新生成后协作者无法调用：旧密钥立即失效——必须将新密钥分享给协作者