菜单

API Key管理

API Key 介绍

  1. 什么是 API Key?
    • API Key 是开发者在发起 HTTP 请求时,作为调用方的身份标识在请求中传入的参数。服务端通过 API Key 识别调用方的身份,并进行权限控制。它是一个随机生成的长度为 35 个字符的文本
  2. 通过 API Key 可以访问 OpenAPI 的相关接口
  3. 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 的权限范围也会随着发生变化
  4. API Key 的生成和管理
    • 提供了具体的产品页面来生成和管理 API Key,详见下方的“功能介绍”
  5. API Key 如何使用
  6. 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 管理

功能介绍

功能入口

  • 入口:项目设置 > 基本设置 > 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
  • 默认 管理员 角色有该权限点

上一个
个人中心
下一个
一次性口令
最近修改: 2025-05-19