1. API Key介绍

（1）什么是API Key？

API Key 是开发者在发起 HTTP 请求时，作为调用方的身份标识在请求中传入的参数。服务端通过API Key识别调用方的身份，并进行权限控制。它是一个随机生成的长度为 35 个字符的文本

（2）通过 API Key 可以访问 OpenAPI 的相关接口

OpenAPI的介绍详见：https://manual.sensorsdata.cn/sa/latest/about_open_api-111904213.html
OpenAPI 的发布随着不同产品组件的发版而不断更新，因此能够使用API Key访问和管理的 OpenAPI 接口会随着不同产品组件的版本而有所不同；详见：https://www.sensorsdata.cn/openApi/home （持续更新）

（3）API Key 的控制范围

1.4.0<=SBP<1.5.0版本中，API Key的使用区分项目：
- 当账号A在指定项目P下创建了一个API Key 时，该 API Key 就会与该账号A和项目P进行绑定，且无法变更绑定关系；即用该API Key 仅能以账号A的身份访问项目P下的OpenAPI
- 一个 API Key 的权限范围（主要是指能通过该API Key能够访问的项目，以及项目下数据权限和功能权限）与该API Key生效的项目以及分配该 API Key 的账号的权限保持一致，当账号的权限调整时，API Key 的权限范围也会随着发生变化
SBP1.5.0及以上版本，API Key的使用不区分项目：
- 当账号A在创建了一个API Key 时，该 API Key 就会与该账号A进行绑定，且无法变更绑定关系；即用该API Key 仅能以账号A的身份使用
- 一个 API Key 的权限范围（主要是指能通过该API Key能够哪些项目，以及这些项目下的数据权限和功能权限）与分配该 API Key 的账号的权限保持一致，当账号的权限调整时，API Key 的权限范围也会随着发生变化

（4）API Key的生成和管理

（5）API Key如何使用

（6）API Key 与 API Secret的关系与对比

类型	生效版本	特性	可以访问的API接口
API Key	SBP1.4之后（含）	只适用于访问OpenAPI 可以任何账号的身份来申请和使用通过申请的账号的权限，控制着访问OpenAPI时的权限支持配置有效期	https://www.sensorsdata.cn/openApi/home （持续更新）
API Secret	SBP1.4之前（不含）	只适用于旧的API 只能以admin的身份来使用 admin密码的修改会导致API Secret改变不支持对能够访问的API进行权限控制不支持配置有效期	https://manual.sensorsdata.cn/sa/2.5/tech_super_api-103776384.html

注：因为从API Secret迁移到API Key，需要对应的从旧的API迁移到OpenAPI，有一定的开发成本，所以老客户（安装过SBP1.4之前版本的客户）会同时存在API Key和API Secret的功能入口

2. 版本说明

SBP1.4之后（含），可以使用API Key管理；

1.4.0<=SBP<1.5.0版本中，API Key是项目级的功能；SBP1.5.0及以上版本，API Key是平台级的功能（以下会对两者区别进行介绍）

1.4.0<=SBP<1.5.0

SBP>=1.5.0:

点击“API Key管理”，进入API Key列表

列表展示字段：
- API Key名称，支持模糊查询
- API Key值，支持复制
- 创建时间，年月日时分秒
- 过期时间，年月日时分秒；已经过期的还会标记出来“已过期”
- 最后一次使用时间，年月日时分秒
支持的操作：
- 新增API Key
- 修改配置
- 删除
列表中只展示当前登录人创建的API Key
- SBP1.4+版本：展示的是当前登录人在当前项目下创建的API Key
- SBP1.5+版本：展示的是当前登录人在平台内创建的API Key，不区分项目
列表中数据按照创建时间倒序排列，即时间最新的排到最前面
过期后的API Key 会失效，但是不会从列表中删除

1.4.0<=SBP<1.5.0版本图示：

SBP>=1.5.0版本图示：

点击“新增”按钮，出现“新增API Key”弹窗，里面显示新增的API Key，并支持复制。（每个账号最多同时存在10个API Key；达到10个后新增按钮无法点击）
“新增API Key”弹窗，可以选择直接关闭弹窗，也可以选择修改配置：
- 点击“关闭”后，列表出现对应的数据：
  - API Key名称，自动生成，规则：“API Key名称{创建的年月日时分秒}” ，比如：API Key名称20220715165727
  - 过期时间，显示为“永久”
- 点击“修改配置”，会进入到API Key的修改配置弹窗：
  - API Key名称，必填，手工输入，最多可输入200个字符
  - 过期时间，默认选中永久；如果选择自定义，会出现时间控件选择，年月日时分秒；
  - 保存时，判断API Key 名称是否填写；以及是否与现有重复

默认「管理员」角色有该权限点

1.4.0<=SBP<1.5.0版本：

SBP>=1.5.0：