1. 获取凭证

根据平台下发的appid和secret获取访问凭证。后续请求业务接口时在请求header中的auth-token字段填充。凭证有效期为两小时,失效后需要重新获取新凭证。

注意

  • 此接口获取的接口凭证用于后续访问业务接口使用。
  • 凭证只能访问对应app申请时选取的服务包含接口,不包含的接口无法调用。
  • 凭证的有效期为7200秒,在有效期内凭证可以重复使用。请勿频繁刷新凭证,此接口限制了调用频率为5秒钟1次,低于五秒钟的重复调用不能获取到新的token。推荐获取到凭证后进行缓存,然后在3600秒到7200秒之间选取合适的时间替换。

1.1. 基本信息

概况 内容
接口地址 /api/platform/token
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求参数(request-parameter)

字段 是否必传 描述
appId 应用ID,开放平台创建
secret 应用密钥,开放平台下发

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 返回码
message string 返回消息
data object 返回数据
authToken string 接口访问凭证
expire number 凭证有效期,单位:秒

响应数据结构如下所示:

{
    "code" : 0,
    "message" : "",
    "data": {
        "authToken" : "XXX",
        "expire" : 7200
    }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""