API Key 介绍
- 什么是 API Key?
- API Key 是开发者在发起 HTTP 请求时,作为调用方的身份标识在请求中传入的参数。服务端通过 API Key 识别调用方的身份,并进行权限控制。它是一个随机生成的长度为 35 个字符的文本
- 通过 API Key 可以访问 OpenAPI 的相关接口
- OpenAPI 的介绍详见:https://manual.sensorsdata.cn/sa/latest/about_open_api-111904213.html
- OpenAPI 的发布随着不同产品组件的发版而不断更新,因此能够使用 API Key 访问和管理的 OpenAPI 接口会随着不同产品组件的版本而有所不同;详见:https://manual.sensorsdata.cn/openapi(持续更新)
- 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 的权限范围也会随着发生变化
- API Key 的生成和管理
- 提供了具体的产品页面来生成和管理 API Key,详见下方的“功能介绍”
- API Key 如何使用
- API Key 与 API Secret 的关系与对比
生效版本 特性 可以访问的 API 接口 API Key SBP 1.4 之后(含) - 只适用于访问 OpenAPI
- 可以任何账号的身份来申请和使用
- 通过申请的账号的权限,控制着访问 OpenAPI 时的权限
- 支持配置有效期
https://manual.sensorsdata.cn/openapi(持续更新) API Secret SBP 1.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,有一定的开发成本,所以老客户(安装过 SBP 1.4 之前版本的客户)会同时存在 API Key 和 API Secret 的功能入口
版本说明
在 SBP 1.4 之后(含),可以使用 API Key 管理