API接口设计说明书.docx
《API接口设计说明书.docx》由会员分享,可在线阅读,更多相关《API接口设计说明书.docx(9页珍藏版)》请在冰豆网上搜索。
API接口设计说明书
XXAPI
接口设计说明书
公司
2016年11月25日
文档管理信息表
主题
XXapi接口设计说明书
版本
内容
关键字
参考文档
创建时间
创建人
最新发布日期
修改人
修改时间
修改内容
创建
编写目的
{说明编写这份用户手册的目的,指出预期的读者。
}
背景
{说明:
a.这份用户手册所描述的软件系统的名称;
b.该软件项目的任务提出者、开发者、用户(或首批用户)及安装此软件的的计算站中心。
}
定义
{列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
}
参考资料
{列出有用的参考资料,如:
a.本项目的经核准的计划任务书或合同、上级机关的批文;
b.属于本项目的其它已发表的文件;
c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
}
统一的输入输出参数
Request
Ianguage
String
Y
cn:
中文,en:
英文,th:
泰文
uid
Int
Y
用户ID.
sid
String
Y
Sessonld(TOKEN
(不需要登录就能调用的接口、注册接口、登录接口,uid和sid两个参数不需要输入)
Response
succeed
Int
Y
0:
失败,1成功
error_code
Int
N
错误码
error_desc
String
N
错误消息
必须登录才能访问的接口
接口名称
描述
user/signout
用户退出
user/photoupload
照片上传
user/changeprofile
修改用户资料
user/changepassword
修改用户密码
user/info
获取用户信息
错误返回码列表
error_code
error_desc
1
授权过期
500
服务器内部错误
600
账号被锁疋
10001
手机号码不能为空
10002
密码不能为空
10003
验证码不能为空
10004
平台类型不正确
10005
手机验证码不正确
10006
手机验证码已失效
10007
用户类型不正确
10008
用户名不能为空
10009
原密码不能为空
10010
新密码不能为空
10011
原密码不正确
10012
经度不能为空
10013
纬度不能为空
10014
对象用户ID不能为空
sidStringYSessonld(TOKEN
Example
Request
用户注册(user/signup)
接口
user/signup
描述
用户注册
验证
Session
方法
GET/POST
Request
mobile
Int
Y
注册手机号.
verify_code
String
Y
手机验证码
password
String
Y
密码
platform
String
Y
平台类型(ios,android)
Response
{
"verify_code":
"123456",
"password":
"111111",
"platform":
"android"
}
Response
1.错误情况
{
"succeed":
0,
"error_code":
10006,
"error_desc":
"手机验证码已失效"
}
2.正常情况
{
"sid":
"sess_573d27b370dc7",
"uid":
"28",
"succeed":
1
}
用户登录(user/signin)
接口
user/signin
描述
用户登录
验证
Session
方法
GET/POST
Request
mobile
Int
N
注册手机号.(type=1时必须)
username
String
N
用户名(type=2、3、4时必须)
password
String
N
密码(type=1时必须)
用户类型
1:
手机号
type
Int
Y
2:
QQ
3:
微信
4:
微博
platform
String
Y
平台类型(ios,android)
Response
id
Int
Y
用户ID
用户角色
user_group
Int
Y
1:
普通用户
2:
专车车主
nickname
String
Y
昵称
email
String
Y
邮箱
mobile
String
Y
手机号
name
String
Y
姓名
username
String
Y
用户名
性别
gender
Int
Y
0:
男
1:
女
age
Int
Y
年龄
birthday
String
Y
出生日期
avatar
String
Y
头像URL
joined_at
String
Y
注册时间
Example
Request
{
"type":
"1",
"password":
"111111",
"platform":
"android"
}
Response
1.错误情况
{
"succeed":
0,
"error_code":
2003,
"error_desc":
"密码错误"}
2.正常情况
{
"sid":
"sess_573d285820a42",
"user":
{
"id":
3,
"user_group":
1,
"nickname":
"test001",
"name":
"王小二",
"username":
"",
"gender":
0,
"age":
26,
"birthday":
"1985-10-10",
"avatar":
"/travel/public/uploadFile/avatar/",
"joined_at":
"2016-05-0310:
15:
53"
},
"succeed":
1
}
我的优惠券(coupon/mycoupon)
接口
coupon/mycoupon
描述
我的优惠券
验证
Session
方法
GET/POST