接口通用说明

概述

本文档所涉及接口基于 HTTPS 协议进行通信，REST风格，使用标准 OAUTH2 协议进行认证、授权，所有接口使用 JSON 格式数据进行交互。

access_token

access_token 是全局唯一的接口调用凭据，调用各接口时都需使用 access_token，对接方需妥善保存。access_token
需确保留有100个字符的存储空间。access_token 的有效期目前为30分钟，需定时刷新，建议在 access_token 剩余有效期小于5分钟时重新获取
access_token。

ps：当出现 invalid_token 错误时请重新获取 access_token。

编码方式

所有接口的字符处理均采用 utf8 编码。

提交数据格式

接口调用方应把需要提交的数据转换成 JSON 格式使用 POST 或者 GET 请求。

注意：所有提交的数据请注意空字符串和 null 值的区别，除非必要，最好不要出现空字符串的情况。

请求示例

{
  "fullName": "张三",
  "applyDate": "2018-04-02"
}

返回数据格式

注：所有错误的返回都有且仅有 error 和 error_description 两个参数。

响应

{
  "error": "0",
  "error_description": "",
  "data": {
    //…  业务数据json
  }
}

响应体

参数名称	数据类型	说明	必须
error	String	状态码，0表示正确，其他值表示错误	是
error_description	String	错误信息描述	否
data	Object	返回的业务数据	否

限流说明

企业超过并发限制时, 返回错误码：RATE_LIMITED

概述#

access_token#

编码方式#

提交数据格式#

请求示例#

返回数据格式#

响应#

响应体#

限流说明#

概述