1. 开发前说明
所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口说明格式如下:
> 请求方式:GET/POST(HTTPS)
> 请求地址:https://yxapi.tusuav.com/xxxx?corpid=ID&corpsecret=SECRET
> 请求包体:
> ...
> 参数说明:
> ...
> 权限说明:
> ...
> 返回结果:
> ...
> 参数说明:
> ...
1.1. 请求方式
标明接口调用的HTTPS方法,区分HttpsGet/HttpsPost请求。所有的请求都为https协议。
1.2. 请求地址
参数中标注大写的单词,表示为需要替换的变量。在上面的例子中 ID 及 SECRET 为需要替换的变量,根据实际获取值更新。假如,这里我们获取到的ID=wwabcdd,SECRET=vQT_03RDV,那么上述的请求在发送时为:https://yxapi.tusuav.com/xxxx?corpid=wwabcdd&corpsecret=vQT_03RDV
1.3. 权限说明
标明接口的使用范围。
1.4. 返回结果/参数说明
标明返回参数示例及说明。特别留意,所有接口在调用失败时返 回包里都有status、tips(部分接口在调用成功时没有返回具体值)。开发者需根据status 存在且不为1判断为失败,否则为成功(status意义请见附录-全局错误码)。而tips仅作 参考,后续可能会有变动,因此不可作为是否调用成功的判据。
参数名 |
必选 |
介绍 |
status |
True |
返回码,1=成功 |
tips |
True |
提示信息 |
data |
True |
数据信息 |