更新时间:2024-08-05 GMT+08:00

调用API方式简介

创建API时,有三种认证方式可选,不同认证方式的API支持的调用方式也有所不同,详见表1
表1 API认证与调用方式说明

认证方式

安全级别

授权与认证机制

支持的调用方式

调用方法示例

使用说明

(推荐)APP认证

通过APP应用将API授权给应用后,使用应用的密钥对(AppKey和AppSecret)进行安全认证。

  • (推荐)SDK调用:支持Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等多种语言。
  • API工具调用:需要通过JavaScript SDK包中的demo.html手动生成签名后,再使用API工具调用。

推荐使用APP认证+SDK调用方式,帮助您简单、快速地通过数据API获取到开放数据。

IAM认证

通过IAM应用或白名单将API授权给账号后,借助从IAM服务获取的用户Token进行安全认证。

API工具调用:需要调用IAM服务的获取用户Token接口获取Token,再使用API工具调用。

通过API工具调用IAM认证方式的API

API工具调用场景可使用IAM认证方式。

无认证

无需授权,所有用户均可访问。

  • API工具调用:直接调用,无需认证信息。
  • 浏览器调用:当API入参位置在Query和Path时,支持浏览器调用。如果入参位置在Header或Body,由于无法传参因此不支持浏览器调用。

无认证方式建议仅在测试接口时使用,不推荐正式使用。若调用方为不可信任用户,则存在数据库安全风险(如数据泄露、数据库高并发访问导致宕机、SQL注入等风险)。