API Key 介绍
- 什么是 API Key？
- API Key 是开发者在发起 HTTP 请求时，作为调用方的身份标识在请求中传入的参数。服务端通过 API Key 识别调用方的身份，并进行权限控制。它是一个随机生成的长度为 35 个字符的 <字符串 String>。
- 通过 API Key 可以访问 OpenAPI 的相关接口
- API Key 的控制范围
- 当账号 A 在创建了一个 API Key 时，该 API Key 就会与账号 A 进行绑定，且无法变更绑定关系；即用该 API Key 仅能以账号 A 的身份使用。
- 一个 API Key 的权限范围（主要是指能通过该 API Key 能够访问哪些项目，以及这些项目下的数据权限和功能权限）与分配该 API Key 的账号的权限保持一致，当账号的权限调整时，API Key 的权限范围也会随着发生变化。
- API Key 的生成和管理
- 提供了具体的产品页面来生成和管理 API Key，详见下方的“功能介绍”章节。
- API Key 如何使用
- API Key 与 API Secret 的关系与对比
- 注：因为从 API Secret 迁移到 API Key，需要对应的从旧的 API 迁移到 OpenAPI，有一定的开发成本，所以老客户（安装过 SBP 1.4 之前版本的客户）会同时存在 API Key 和 API Secret 的功能入口。
功能介绍
API Key 是平台级的功能
功能入口
SBP 1.5.0:
SBP 1.5.1+:
API Key 列表
点击 API Key 管理，进入 API Key 列表
- 列表展示字段：
- API Key 名称，支持模糊查询
- API Key 值，支持复制
- 创建时间，年月日时分秒
- 过期时间，年月日时分秒；已经过期的还会标记出来 已过期
- 最后一次使用时间，年月日时分秒
- 支持的操作：
- 列表中只展示当前登录人创建的 API Key
- 展示的是当前登录人在平台内创建的 API Key，不区分项目
- 列表中数据按照创建时间倒序排列，即时间最新的排到最前面
- 过期后的 API Key 会失效，但是不会从列表中删除
新增 API Key
- 点击 新增 按钮，出现 新增 API Key 弹窗，里面显示新增的 API Key，并支持复制。（每个账号最多同时存在 10 个 API Key；达到 10 个后新增按钮无法点击）
- 新增 API Key 弹窗，可以选择直接关闭弹窗，也可以选择修改配置：
- 点击 关闭 后，列表出现对应的数据：
- API Key 名称，自动生成，规则：API Key 名称{创建的年月日时分秒} ，比如：API Key 名称 20220715165727
- 过期时间，显示为 永久
- 点击 修改配置，会进入到 API Key 的修改配置弹窗：
- API Key 名称，必填，手工输入，最多可输入 200 个字符
- 过期时间，默认选中永久；如果选择自定义，会出现时间控件选择，年月日时分秒；
- 保存时，判断 API Key 名称是否填写；以及是否与现有重复
修改 API Key 配置
- API Key 支持修改，点击修改配置出现对应的修改弹窗
删除 API Key
- API Key 支持删除，点击删除时会有二次确认弹窗，再次确认后删除
权限控制
默认 管理员 角色有该权限点
- 管理权限 > API Key > 管理 API Key
