1. 系统 API Key
系统 API Key 由系统平台统一创建和管理,适合为指定组织、指定用户生成长期或定期失效的访问凭证。
它与个人中心里的用户 API Key 不同:个人 API Key 只能由当前用户为自己创建和管理;系统 API Key 由系统管理员选择租户和用户后签发。
1.1. 创建流程
- 进入系统平台的 API Key 页面。
- 选择组织。选择组织后,用户下拉框才会加载该组织内的用户。
- 选择用户。
- 填写名称、过期时间和备注。
- 保存后复制
secret_key,并妥善保管。
1.2. 字段说明
| 字段 | 说明 |
|---|---|
| 名称 | API Key 的显示名称,用于区分用途。 |
| 组织 | API Key 所属租户。 |
| 用户 | API Key 代表的用户身份。用户列表来自所选组织。 |
| 过期时间 | 凭证失效时间。留空时按平台默认策略处理。 |
| 备注 | 用于记录调用方、用途或交接信息。 |
secret_key | 签发后的密钥,只应在可信渠道保存和使用。 |
1.3. 编辑限制
编辑已有 API Key 时,组织和用户不可修改。平台不会在编辑时重新生成 secret_key。
如果需要变更组织或用户,应删除旧 Key 后重新创建。
1.4. 权限说明
API Key 的身份信息按所选用户和组织签发。调用接口时,该 Key 代表对应用户在对应组织下的访问身份。
删除 API Key 后,缓存中的凭证也会被清理。外部系统应及时停用已删除或已过期的 Key。
1.5. 使用建议
- 为每个外部系统单独创建 API Key,避免多人或多个系统共用同一个 Key。
- 设置明确过期时间,并在到期前完成轮换。
- 备注中写清用途、负责人和调用系统。
- 不要把
secret_key写入公开文档、前端代码或日志。