Skip to content

认证与鉴权

所有版本的 API 都支持两种认证方式:

  1. App Key & App Secret 认证(推荐):更安全,使用签名机制
  2. Token 认证(不建议):简单但存在泄漏风险

在访问控制界面中:

  • App Key & App Secret 认证对应 API 凭证管理(推荐)
  • Token 认证对应 Token 管理

访问控制界面

不同版本的 API 在认证凭证的传递位置上有差异,请根据您使用的 API 版本查看对应的认证文档。

v3 API

v3 API 支持两种认证方式:

  • App Key & App Secret 认证:认证凭证放在 HTTP Header 中
    • 凭证位置:HTTP Header x-cy-app-key
  • Token 认证:认证凭证通过 Query 参数或 Header 传递
    • 凭证位置:URL Query 参数 token 或 HTTP Header Authorization: Bearer {token}

详细文档:v3 API 认证与鉴权

v2.6 API

v2.6 API 支持两种认证方式:

  • App Key & App Secret 认证:认证凭证放在 URL 路径中
    • 凭证位置:URL 路径中的 {app_key} 参数
  • Token 认证:认证凭证放在 URL 路径中
    • 凭证位置:URL 路径中的 {token} 参数

详细文档:v2.6 API 认证与鉴权

v2 系列(v2.2 - v2.5)

v2.2 - v2.5 版本使用 Token 认证方式,认证凭证放在 URL 路径中。

  • 认证凭证位置:URL 路径中的 {token} 参数
  • 示例:https://api.caiyunapp.com/v2.5/{token}/{longitude},{latitude}/realtime

注意

v2.2 - v2.5 版本已停止维护,建议迁移至 v2.6 或 v3 版本。

v1 API

v1 API 支持两种认证方式:

  • App Key & App Secret 认证:认证凭证放在 URL Query 参数中
    • 凭证位置:URL Query 参数 token(作为 app_key)
  • Token 认证:认证凭证放在 URL Query 参数中
    • 凭证位置:URL Query 参数 token

详细文档:v1 API 认证与鉴权

注意

v1 API 已标记为 Deprecated,建议迁移至 v2.6 或 v3 版本。