跳到主要内容

API授权

听云提供各功能模块的数据导出API，所有API都使用同一种认证方式。

听云API认证​

术语​

api_key：平台为每一个管理员（主账号）分配的公钥，是请求API时用来校验身份的一串字符，可在“用户中心 > 账户管理 > API页面”获取。

secret_key：用于生成数字签名的私钥，与 api_key 一 一对应，可在“用户中心 > 账户管理 > API页面”获取。

timestamp：当前请求时间戳（毫秒时间戳）。

auth：通过特定的规则生成的数字签名。

认证说明​

API认证

  1. 用户向认证服务发起请求，请求包含api_key、auth、timestamp参数。

  2. 认证服务收到请求后，会对参数进行校验，校验通过后会返回access_token。

  3. 用户收到access_token后，就可以拿access_token去请求API获取数据。

access_token说明：

  1. access_token有效期2小时，过期失效。

重复申请access_token，会导致前一次申请的access_token失效，以最近一次申请的为准。

  1. access_token失效后需重新申请，建议建立access_token更新机制，以便在access_token失效后可以及时更新。

auth计算规则：

  1. auth字符串拼接

api_key="这里是api_key的值"&secret_key="这里是secret_key的值"&timestamp="这里是当前请求的毫秒时间戳"

  1. auth字符串加密，对auth拼接完的字符串进行32位小写MD5加密

获取access_token​

接口调用地址：${host}/my-api/auth/token?api_key=xxxxx&auth=xxxxx&timestamp=xxxxxx

参数说明

字段名类型描述
api_keyString身份校验码
authString加密签名
timestampLong当前请求的毫秒时间戳

返回说明

示例：

{

"code":200,

"msg":"success",

"access_token":" hbWUiOiLkupHljZfnlLXnvZEiLCJjb"

}

说明：

参数名描述
code返回码
msg返回消息
access_tokenaccess_token，用于调用听云API时做身份认证

返回码说明：

CodeMSG描述
200success成功
40001Invalid timestamp无效的时间戳
40002Invalid api_key无效的api_key
40003Invalid auth无效的签名

调用听云API获取数据​

调用听云API获取数据，需要在请求的Headers里添加Authorization参数，参数值为"Bearer"+\${access_token}。

Authorization示例：

Authorization= Bearer hbWUiOiLkupHljZfnlLXnvZEiLCJjb

注意：Bearer和access_token之间有一个空格。