API 密钥

简述

API 密钥用于在调用开放接口时携带鉴权信息。您可为不同应用或环境创建多条密钥，分别授予 chat、config 等权限组合；支持复制掩码后的密钥、轮换密钥与吊销密钥。新建或轮换成功后系统会一次性展示完整密钥串，请立即下载或复制保存。

功能位置

点击侧边栏 系统管理，再选择 API 密钥。页面主标题为 API 密钥，副文案说明密钥用途并要求勿泄露。

配置与规则

列表

• 名称：主标题展示自定义名称；
• 密钥：展示掩码后的前缀；成功提示「已复制到剪贴板」。已吊销的密钥行按钮不可用。
• 权限范围：以彩色标签展示每条密钥拥有的 scope，界面可选 chat 与 config，含义分别为对话类能力与配置类能力。
• 状态：启用 用绿色圆点表示；已吊销 用灰色圆点表示。吊销后操作列不再展示轮换与吊销图标。

新建密钥

弹窗标题 新建密钥，字段包括：

• 名称：必填，最长 128 字符；
• 权限范围：至少勾选一项；若全部取消后提交会提示「至少选择一个权限范围」。默认勾选 chat。
• 说明：选填，最长 500 字符。

底部 创建 成功后提示「密钥已创建」，并弹出 密钥创建成功 结果窗，展示完整密钥与 复制密钥 按钮

轮换密钥

点击行内轮换图标打开 轮换密钥 弹窗。正文说明：轮换后旧密钥立即失效，使用该密钥的请求将无法通过鉴权。

吊销密钥

点击吊销图标打开确认框 吊销密钥，确认按钮 确定吊销。成功后提示「密钥已吊销」，该行状态变为 已吊销。

注意事项

• 轮换与吊销都会立刻影响线上流量，请在业务低峰执行并同步更新集成方配置。
• chat 与 config 权限决定密钥可访问的接口类别，创建前请与研发核对最小权限原则。
• 列表中的复制能力依赖网络与权限；失败时请阅读顶部或气泡错误提示。

与其他功能的关系

• 会话记录：来源为 API 的会话由携带本密钥或其它合法凭证的调用创建，可用于核对接入侧行为。
• 渠道：访客 Web SDK 场景通常走渠道令牌链路，与 API 密钥并行存在，勿混用保管流程。

业务场景示例

生产与测试密钥拆分

角色与目标
您负责为多套部署隔离权限，避免测试脚本误触生产配置。

系统配置
创建两条密钥，名称区分环境；测试密钥仅勾选 chat，运维密钥额外勾选 config 以便调用管理接口。

场景效果
泄露影响面可控；吊销其中一条不会影响另一条承载的业务流量。