API接口设计说明书

XXAPI
接口设计说明书
公司
2016年11月25日
文档管理信息表
文档变更记录表
目录
文档变更记录表 .................................................................................................................................................................................. 目录 .................................................................................................................................................................................................... 引言 ...................................................................................................................................................................................................... 编写目的
背景
定义
参考资料
综述 ...................................................................................................................................................................................................... 统一的输入输出参数
必须登录才能访问的接口
错误返回码列表
用户接口 .............................................................................................................................................................................................. 用户注册（user/signup）
用户登录（user/signin）
优惠券接口 .......................................................................................................................................................................................... 我的优惠券（coupon/mycoupon）
引言
编写目的
{说明编写这份用户手册的目的，指出预期的读者。

}
背景
{说明：
a．这份用户手册所描述的软件系统的名称；
b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中心。

}
定义
{列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

}
参考资料
{列出有用的参考资料，如：
a．本项目的经核准的计划任务书或合同、上级机关的批文；
b．属于本项目的其它已发表的文件；
c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

} 综述
统一的输入输出参数
Request
（不需要登录就能调用的接口、注册接口、登录接口，uid和sid两个参数不需要输入）Response
必须登录才能访问的接口
错误返回码列表
用户接口
用户注册（user/signup）
Request
Response
Example
Request
{
"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）
Request
Response
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/empty.png",
"joined_at": "2016-05-03 10:15:53"
},
"succeed": 1
}
优惠券接口
我的优惠券（coupon/mycoupon）。