API接口文档(简单版)Word下载.docx
《API接口文档(简单版)Word下载.docx》由会员分享,可在线阅读,更多相关《API接口文档(简单版)Word下载.docx(4页珍藏版)》请在冰豆网上搜索。
1.1 描述 2
1.2 请求地址 2
1.3 请求参数 2
1.4 返回数据 2
1.5 请求URL实例 2
1.6 返回数据实例 3
2. API名称 3
2.1 描述 3
2.2 请求地址 3
2.3 请求参数 3
2.4 返回数据 3
2.5 请求URL实例 3
2.6 返回数据实例 3
1.登陆
1.1描述
登陆的接口
1.2请求地址
操作
login
协议
HTTP
方式
GET
ULR全径
请求的URL地址的全称
1.3请求参数
序号
参数名
中文名称
必选
数据类型
长度
备注
1
para1
第一个参数
Y
String
20
这个API的第一个参数
2
Para2
第二个参数
N
这个API的第二个参数
1.4返回数据
返回值
code
请求状态码
200请求成功,400请求失败(参数有误,等)
data
返回数据
数组,数组中可能有键值对
3
result
返回结果
0发送验证码成功,1失败
1.5请求URL实例
1.6返回数据实例
{
"
code"
:
200,
data"
[
result"
}
]
2.API名称
2.1描述
这个API是用来做什么的,以及注意点
2.2请求地址
操作名称
地址
2.3请求参数
2.4返回数据
2.5请求URL实例
2.6返回数据实例
4