7.1 接口基本规范

1.   接口类型：所有接口均采用 RESTful 架构风格，基于 HTTP/HTTPS 协议传输

2.   数据格式：请求与响应数据均采用 JSON 格式，字符编码统一为 UTF-8

3.   请求方法：遵循 HTTP 标准方法，GET 用于查询数据，POST 用于创建数据，PUT 用于更新数据，DELETE 用于删除数据

4.   接口域名：公有云版统一接口域名：www.lijiy.com；私有化部署版使用客户自定义域名

5.   版本控制：接口版本通过 URL 路径标识，例如：

7.2 接口鉴权规范

1.    所有接口调用必须携带鉴权信息，采用 Access Token 鉴权机制

2.    开发者需通过/v1/auth/token接口，使用 AppKey 与 AppSecret 换取有效期为 2 小时的 Access Token

3.    业务接口请求时，需在 HTTP Header 中携带Authorization: Bearer {Access Token}，完成身份鉴权

4.    平台对接口调用频率进行限流，默认单应用接口调用频率上限为 1000 次 / 分钟，可根据客户需求调整

7.3 核心接口列表

表格

7.4 响应码规范

平台接口采用统一的 HTTP 状态码与业务响应码，核心规范如下：

表格

业务响应通过统一格式返回，示例如下：

json

{
  "code": 0,
  "msg": "success",
  "data": {}
}

·        code=0 表示业务执行成功，非 0 表示业务执行失败，对应具体业务错误码

·        msg 为响应信息，成功时返回 success，失败时返回具体错误描述

·        data 为响应业务数据，成功时返回对应数据，失败时可返回空