API 请求认证

创建时间:2024-11-01 最近修改时间:2024-11-01

#1. API 请求认证

#1.1 API Key

6.5 版本开始,DeepFlow 使用 API Key 来进行 API 请求的认证。

警告

注意,6.5 版本不再支持创建老版本的永久 token,已经创建的永久 token 依然可以使用,但请尽快更新为 API Key,后续版本将不再支持永久 token 的访问。

#1.1.1 申请 API Key

API Keys页面中创建 API Key,这些 API Key 可用于查询当前用户在当前组织下的数据。注意如果需要查询不同的组织,需要到对应的组织下创建对应的 API key。

alt text

alt text

alt text

alt text

alt text

alt text

#1.1.2 使用 API Key

在请求的 header 中增加 API-KEY: 申请的Key 即可:

alt text

alt text

当 API Key 错误时,返回:

错误

错误