API文档

# 开放 API 接口文档

开放 API 接口文档

# 相关文档

# 开发文档阅读说明

一、文档的阅读次序，建议先阅读一遍开发指南，以及接口access_token获取。然后就可以独立查看各个功能块文档说明。

二、所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口格式说明如下：

1. 请求方式

| 项 | 值 |
| --: | :-- |
| URI | /v1/getAccessToken.json |
| 描述 | 请求令牌 |
| 请求方式 | GET |
| 需要登录 | 否 |
| 注意事项 | 无 |
| 其他 | 无 |

2. 请求参数

| 属性名 | 类型 | 备注 |
| :--: | :--: | :--: |
| appId  | String | 开放平台颁发的 appId  |
| secret | String | 开放平台颁发的 secret |

3. 请求示例

```json
https://api.kinyun.cn/v1/getAccessToken.json?appId=APPID&secret=SECRET
```

4. 响应结果

```json
{
    "code": 0,
    "msg": null,
    "data": {
        "accessToken": "YOUR_ACCESS_TOKEN", // 令牌
        "expire": 7200                      // 令牌有效时间(单位: 秒)，默认2小时
    },
    "pageDto": null
}
```

  1. 请求方式，标明接口调用的HTTP方法，区分GET/POST请求。所有的请求都为https协议。

  2. 请求参数，标明请求参数示例及说明，参数说明包括字段含义、取值范围，开发者在设计数据结构时，应参考该定义范围。

  3. 请求示例，参数中标注大写的单词，表示为需要替换的变量。在上面的例子中 APPID 及 SECRET 为需要替换的变量，根据实际获取值更新。假如，这里我们获取到的APPID=akycw6ufq53jvnbziabc，SECRET=f3a362cb656aaf9ba0df24a0dc3029ed8dbe3d0f，那么上述的请求在发送时为：

https://api.kinyun.cn/v1/getAccessToken.json?appId=akycw6ufq53jvnbziabc&secret=f3a362cb656aaf9ba0df24a0dc3029ed8dbe3d0f

  1. 响应结果，标明返回参数示例及说明。特别留意，所有接口在调用失败时返回包里都有 code、msg。开发者需根据 code 存在且不为0判断为失败，否则为成功。而 msg 仅作参考，不可作为是否调用成功的判据。

# 接口调用流程

  1. 获取 ACCESS_TOKEN，参考 文档说明。
  2. 缓存和刷新 ACCESS_TOKEN 。
  3. 调用具体的业务接口.

注意：开发者需要缓存 ACCESS_TOKEN，用于后续接口的调用（注意：不能频繁调用 /v1/getAccessToken.json 接口，否则会受到频率拦截）。当 ACCESS_TOKEN 失效或过期时，需要重新获取。

接口授权 →