API接口设计项目说明指导书.docx

XXAPI接口设计说明书企业11月25日文档管理信息表专题XX api接口设计说明书 版本V0.1内容关键字参考文档创建时间创建人最新公布日期文档变更统计表修改人修改时间修改内容创建目 录文档变更统计表3目 录1引言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参数名类型是否必需描述languageStringYcn:汉字，en:英文，th：泰文uidIntY用户ID. sidStringYSessonId（TOKEN）（不需要登录就能调用接口、注册接口、登录接口，uid和sid两个参数不需要输入）Response参数名类型是否必需描述succeedIntY0：失败，1：成功error_codeIntN错误码error_descStringN错误消息必需登录才能访问接口接口名称描述user/signout用户退出user/photoupload照片上传user/changeprofile修改用户资料user/changepassword修改用户密码user/info获取用户信息错误返回码列表error_codeerror_desc1授权过期500服务器内部错误600账号被锁定10001手机号码不能为空10002密码不能为空10003验证码不能为空10004平台类型不正确10005手机验证码不正确10006手机验证码已失效10007用户类型不正确10008用户名不能为空10009原密码不能为空10010新密码不能为空10011原密码不正确10012经度不能为空10013纬度不能为空10014对象用户ID不能为空用户接口用户注册（user/signup）接口user/signup描述用户注册验证Session方法GET/POSTRequest参数名类型是否必需描述mobileIntY注册手机号. verify_codeStringY手机验证码passwordStringY密码platformStringY平台类型（ios,android）Response参数名类型是否必需描述sidStringYSessonId（TOKEN）uidIntY用户IDExampleRequest mobile: , verify_code: 123456, password: 111111, platform: androidResponse1.错误情况 succeed: 0, error_code: 10006, error_desc: 手机验证码已失效2.正常情况sid: sess_573d27b370dc7,uid: 28, succeed: 1用户登录（user/signin）接口user/signin描述用户登录验证Session方法GET/POSTRequest参数名类型是否必需描述mobileIntN注册手机号. (type=1时必需)usernameStringN用户名(type=2、3、4时必需)passwordStringN密码(type=1时必需)typeIntY用户类型1：手机号2：QQ3：微信4：微博platformStringY平台类型（ios,android）Response参数名类型是否必需描述sidStringYSessonId（TOKEN）userArrayY用户信息idIntY用户IDuser_groupIntY用户角色1：一般用户2：专车车主nicknameStringY昵称emailStringY邮箱mobileStringY手机号nameStringY姓名usernameStringY用户名genderIntY性别0：男1：女ageIntY年纪birthdayStringY出生日期avatarStringY头像URLjoined_atStringY注册时间ExampleRequest type: 1, mobile: , password: 111111, platform: androidResponse1.错误情况 succeed: 0, error_code: , error_desc: 密码错误2.正常情况 sid: sess_573d285820a42, user: id: 3, user_group: 1, nickname: test001, email: , mobile: , name: 王小二,username : , gender: 0, age: 26,birthday :1985-10-10, avatar: /travel/public/uploadFile/avatar/empty.png, joined_at: -05-03 10:15:53 , succeed: 1 优惠券接口我优惠券（coupon/mycoupon）接口coupon / mycoupon描述我优惠券验证Session方法GET/POST