创建 API Key
创建 API Key，管理关联产品、Webhook、IP 白名单、密钥替换与状态。
本页介绍如何在 Console > Developers 中创建和管理当前 Workspace 的 API 凭证。代码接入及请求鉴权请参阅鉴权。
开始之前
-
确认当前选中的 Workspace：API Key 归属于该 Workspace，不归属于创建它的个人。
-
至少已开通一个产品：未开通任何产品时，不能创建 API Key；只有已开通产品才能在 Key 中选择授权。
-
具备对应操作权限：查看、创建和管理 API Key 的权限由当前 Workspace 中分配的角色决定。组织 Owner 是组织层级的所有者身份，不参与 Workspace 角色权限的判定。
| 凭证 | 作用 |
|---|---|
| API Key | 标识调用所使用的密钥及其所属 Workspace。 |
| API Secret | 配合 API Key 按产品鉴权要求验证调用身份，必须安全保存。 |
创建 API Key
填写基本信息
点击 Create ApiKey。在 APIKEY NAME 中填写便于识别应用或用途的名称，Description 为选填；点击 Continue。
选择产品
在 Activate products 中选择此密钥需要使用的已开通产品，再点击 Continue。
核对并生成
核对名称和产品。Webhook 与 IP 白名单初始为 Not configured，可创建后在详情中补充；点击 Generate ApiKey。
所选产品授权无需审核，可直接激活。发送生产流量前，核对密钥及关联产品的状态。
安全保存凭证
复制 API KEY 和 API SECRET，或点击 Download TXT 下载并安全保存在服务端。勾选 I have copied and stored the secret safely，再点击 Continue to ApiKey detail。
Secret 仅展示一次，关闭后无法找回。不要放入浏览器代码、代码仓库、日志或共享截图。
查看与管理 API Key
查找密钥与查看详情
通过 all、active、disabled 或 Search name or prefix 查找密钥，点击 Actions 中的眼睛图标打开详情。在 Overview 中查看密钥前缀、状态、创建人、创建时间和关联产品。
添加产品授权
点击 Add products，选择当前 Workspace 已开通且此 Key 尚未关联的产品，再点击 Confirm。标记 Already added 的产品不能重复添加。产品开通与 Key 产品授权均无需审核，可直接激活。
当前不支持取消已有产品绑定，也不支持对已添加产品重新申请授权。添加前请确认目标产品和用途。
配置 Webhook
打开 Webhooks，点击 Add webhook。
-
Product — 选择产品。Webhook 按 API Key 与产品组合配置，新增时已配置的产品会隐藏。
-
Endpoint URL — 填写接收回调的 HTTPS 地址。
-
Event types — 勾选需要接收的事件，可选事件随产品变化。
-
Signing secret — 可选开启回调验证，并按产品文档规定的机制实现验签。
点击 Add webhook 保存。
配置 IP 白名单
打开 IP Whitelist，填写调用服务器的公网 IP 或 CIDR，按需补充说明，再点击 Add。点击条目右侧的删除图标可移除该条规则。
修改前确认业务服务实际使用的出口 IP，避免预期调用方被拦截。
替换密钥
当 Secret 丢失、凭证疑似泄露，或需要定期轮换凭证时，使用 Replace Key 创建替代密钥。Secret 丢失后无法找回；新凭证需要更新到所有调用方。
若凭证疑似泄露，应尽快停用旧密钥，阻止其继续被使用；此时可能影响尚未切换的业务调用。常规轮换时，先验证新密钥，再停用旧密钥。
打开 Replace Key，填写 New key name，点击 Create replacement。新密钥会复制关联产品、Webhook 和 IP 白名单；保存新 Secret，更新业务系统中的凭证并验证调用，再停用旧密钥。
旧密钥不会自动失效。所有调用方切换完成后，需要手动停用旧密钥。
停用与恢复
停用
打开密钥详情，进入 Danger Zone，点击 Disable this ApiKey，再点击 Confirm。
恢复
找到已停用密钥，点击 Restore，再点击 Confirm；恢复请求前检查密钥状态。
停用会立即阻止此密钥的 API 调用，历史记录和配置仍保留。当前界面支持停用，不提供删除密钥的操作。
下一步：使用凭证调用 API
凭证和请求头的具体要求请阅读鉴权，再按对应产品快速开始完成一次受控请求验证。
最后更新于