全部文档
文档中心先胜云平台使用API密钥鉴权

使用API密钥鉴权

第三方调用平台及组件服务接口时,需要鉴权。现有鉴权方式主要通过token,但要先调用登录接口获取token。平台新增鉴权方式【API密钥】,并提供密钥管理页面,用于配置、生成密钥

  • 按空间配置API密钥,入口:空间 → API密钥,目前仅企业管理员、空间管理员可见、可配置

  • 点击新建,创建空间访问密钥

配置项

说明

密钥标识名称

密钥的描述文字,如:自动化数据同步

接口执行用户

默认为当前用户

授权应用范围

当前空间下全部应用或指定应用

授权有效期

永久有效或指定日期(有效至该日期23:59:59)

  • 点确定后,生成密钥。注意:密钥只会显示这一次,请立即复制并妥善保存

  • 一键复制并关闭后,列表显示新建密钥信息,包括:密钥配置、最后使用时间等。可点编辑,编辑密钥配置

使用方式:原接口Headers里的cookie与token部分,可由API密钥代替,对应键为X-Deepfos-Key

调用逻辑:带着API密钥调用接口时,平台会先校验密钥的有效性,包括:应用范围、有效期等,再替换为接口执行用户的cookie

应用示例:使用接口启动数据流

  • 复制数据流cURL,贴入API调用工具

  • Headers里删除原有cookie与token,新增一行:键为X-Deepfos-Key,值为之前复制保存下来的密钥

  • 点运行启动该流程,流程实例如下

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT,基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send