API接口设计说明书

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

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

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

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

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

｝
综述
统一的输入输出参数
Request
（不需要登录就能调用的接口、注册接口、登录接口，和两个参数不需要输入）
必须登录才能访问的接口
错误返回码列表
用户接口用户注册(user/signup)
Request
Response
Example
Request
"mobile”：:
w verify_code M： *123456\
"password•: ^llllir,
"platform■: "android"
Response
1 •错误情况
{
"succeed"： 0.
n error_code M：
10006.
"eiTor_desc"：”手机验证码已失效“
2 •正常情况
{
•sid•: M sess_573d27b370dc7\
•uid•: rt28\
"succeed"： 1
用户登录(user/signin)
接口user/signin
Request
Response
Example
Request
type”： T.
“mobile”：二
"password"：H llllll\
^platform"： "android'*
Response
1.错误情况
{
"succeed"： 0.
” error_code *'： 2003.
w error__desc ”："密码错误w
}
2.正常情况
{
•id”：M sess_573d285820a42M.
"user"： {
”id”： 3.
w usei'_group*： 1,
Fickname”： ^testOO 1H.
”email”：w\
"mobile1*：:
Fame”：”王小二”，
"username":
"gender"： 0,
"age"： 26.
"birthday ”「1985-10-10”，
"avatar”： "/travel/public/uploadFile/avatar/M, ”joined_at"：”2016-05-03 10:15:53”
"succeed"： 1
优惠券接口
我的优惠券(coupon/mycoupon)。