API接口设计说明书

XXAPI接口设计说明书公司文档管理信息表主&XX api接口设计说明书版本V0.1容关键字参考文档创建时间创建人最新发布日期文档变更记录表文档变更记录表3目录1引言1编写目的1背景1定义1参考资料1综述2统一的输入输出参数2必须登录才能访问的接口 2错误返回码列表3用户接口 5用户注册(user/signup)5用户登录(user/signin)6优惠券接口 11我的优惠券(coupon/mycoupon)111 / 162 / 16引言编写目的说明编写这份用户手册的目的，指出预期的读者。背景说明：a. 这份用户手册所描述的软件系统的名称；b. 该软件项目的任务提出者、开发者、用户（或首批用户）与安装此软件的的计算站中心。定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。参考资料列出有用的参考资料，如：a. 本项目的经核准的计划任务书或合同、上级机关的批文；b. 属于本项目的其它已发表的文件；c. 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。综述统一的输入输出参数RequestlanguageStringYcn:中文，en:英文，th：泰文uidIntY用户ID.sidStringYSessonld（TOKEN）（不需要登录就能调用的接口、注册接口、登录接口，uid和sid两个参数不需要输入）ResponsesucceedInt0：失败，1：成功Yerror codeInt错误码error descString错误消息必须登录才能访问的接口错误返回码列表error_codeerror_desc1授权过期500服务器部错误600账号被锁定10001手机不能为空10002密码不能为空10003验证码不能为空10004平台类型不正确10005手机验证码不正确10006手机验证码巳失效10007用户类型不正确10008用户名不能为空10009原密码不能为空10010新密码不能为空10011原密码不正确用户接口用户注册(user/signup)Request注册手机号.mobile手机验证码verify_code密码平台类型(ios,android)passwordResponsesiduidSessonld (TOKEN)ExampleRequestResponse用户登录(user/signin)接口user/signinRequestmobileIntN注册手机号.（type=1时必须）usernameStringN用户名（type=2、3、4时必须）passwordStringN密码（type=1时必须）用户类型1：手机号typeIntY2：3 :微信4：微博platformStringY平台类型（ios,android）ResponsesidSessonld (TOKEN)idIntY用户ID用户角色user_groupIntY1：普通用户2：专车车主nicknameStringY昵称emailStringYmobileStringY手机号nameStringYusernameStringY用户名性别genderIntY0：男1：女ageIntY年龄birthdayStringY出生日期avatarStringY头像URLjoined_atStringY注册时间ExampleRequesttype: 1Response优惠券接口我的优惠券(coupon/mycoupon )