创建密钥
- 打开设置,再打开 API 密钥,选择创建密钥。
- 以使用此密钥的系统命名。选择权限范围,并可设置到期时间。
- 立即复制密钥,并保存至系统的密钥存储中。
Important: 完整密钥仅显示一次。如遗失,请撤销并创建新密钥。
| 权限范围 | 等同角色 |
|---|---|
| 只读 | 查看者。可读取查看者有权读取的内容。 |
| 读写 | 最高等同经理。可创建及修改经理有权操作的内容。 |
使用方法
在发送至应用 API 的每个请求的 Authorization 请求头中提供密钥:
Authorization: Bearer ehk_...
- 密钥仅适用于所属组织及其权限范围。
- 使用密钥时不需要 CSRF 请求头。
- 密钥无法创建或管理其他密钥。
- 使用密钥发起的请求会以 API 密钥身份记录在审计日志中。
撤销
选择密钥的撤销后,密钥立即失效,使用它的系统会收到 401 错误。创建密钥的成员离开组织时,密钥也会失效。列表显示每个密钥的最近使用时间。
Tip: 尽可能为每个集成分别提供只读密钥。如有泄露,只需撤销对应密钥。
如需供开发人员使用的 API 说明,请通过联系表单申请。