API Key 管理
按确认调用范围、创建密钥、收紧权限和接口验证的顺序建立程序化访问能力。
功能概述
API Key 用于给程序、脚本和外部系统提供访问 Clouisle 的身份。
它不是给人登录用的账号替代品,而是一种独立的程序身份治理方式。
适用场景
API Key 常用于:
- 外部系统调用 Agent 或工作流
- 自动化平台访问知识库、文件或会话接口
- 定时任务、机器人或集成平台长期调用 API
前置条件
开始前建议先确认:
- 调用方系统是谁
- 需要访问哪些 API 范围
- 是否需要过期时间、启停控制和速率限制
- 是否已经准备好一个最小调用样例
操作步骤
第 1 步:先明确 Key 的使用范围
在创建之前,先回答清楚这把 Key 到底用来做什么,例如:
- 只调用某个 Agent
- 只触发某条工作流
- 需要访问多个业务能力接口
这一步越明确,后面的权限越容易收紧。
第 2 步:创建 Key,并使用可追踪的命名方式
创建时建议名称至少包含:
- 调用系统名称
- 环境,例如测试或生产
- 用途说明
例如:crm-prod-agent-call。
这样后续在日志、审计或轮换时更容易快速识别。
第 3 步:限制权限和生命周期
创建后应重点确认:
- 允许访问哪些资源
- 是否默认启用
- 是否设置过期时间
- 是否配置速率限制
生产环境不要为了省事一上来就开全量权限。
第 4 步:立即做一次最小接口验证
Key 创建完成后,应立刻拿真实请求做一次最小测试,至少确认:
- 鉴权成功
- 目标接口可以调用
- 未授权接口会被拒绝
如果这一步都不验证,后面联调时很容易把权限问题误判成接口问题。
第 5 步:补上停用、轮换和回收规则
当 Key 开始进入正式系统后,还应同步定义:
- 到期前多久轮换
- 系统下线后由谁回收
- 异常泄露时如何紧急停用
结果验证
一个治理正常的 API Key,至少应满足:
- 目标接口调用成功
- 未授权接口调用失败
- 停用后立即失效
- 可追踪最后使用时间和用途归属
常见问题
为什么 API Key 调用一直失败
优先检查:
- Key 是否有效
- 请求头是否正确
- 调用接口是否超出授权范围
- 环境地址是否写错
为什么不建议多人或多个系统共用同一把 Key
因为一旦出问题,很难追责,也很难单独回收某一个系统的访问权限。
为什么要设置过期时间和轮换机制
如果 Key 长期有效且无人管理,一旦泄露,风险会持续存在。
轮换和回收机制是程序身份治理不可缺少的一部分。
注意事项
- 一个系统一个 Key,按环境分开发放
- API Key 应始终遵循最小权限原则
- 正式联调前,先用最小请求验证鉴权和授权是否正确