《API接口设计说明书》由会员分享，可在线阅读，更多相关《API接口设计说明书（17页珍藏版）》请在装配图网上搜索。
1、XXAPI接口设计说明书公司2016年11 月25 日文档管理信息表文档变更记录表目录文档变更记录表 错误!未定义书签。目录 错误!未定义书签引言 错误!未定义书签编写目的 错误!未定义书签。背景 错误!未定义书签。定义 错误!未定义书签。参考资料 错误!未定义书签。综述 错误!未定义书签统一的输入输出参数 错误!未定义书签。必须登录才能访问的接口 错误!未定义书签。错误返回码列表 错误!未定义书签。用户接口 错误!未定义书签用户注册(user/signup) 错误!未定义书签。用户登录( u s er/ s i gn i n ) 错误!未定义书签。优惠券接口 错误!未定义书签我的优惠券(co
2、upon/mycoupon)错误!未定义书签。引言编写目的说明编写这份用户手册的目的，指出预期的读者。背景说明：a 这份用户手册所描述的软件系统的名称；b 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中心。定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。参考资料列出有用的参考资料，如：a 本项目的经核准的计划任务书或合同、上级机关的批文；b 属于本项目的其它已发表的文件；c 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。languageStringcn:中
3、文，en:英文，th：泰文uidInt用户ID.sidStringSessonId （TOKEN）（不需要登录就能调用的接口、注册接口、登录接口，uid和sid两个参数不需要输入）Response描述错误消息参数名类型是否必须0：失败，1：成功必须登录才能访问的接口综述统一的输入输出参数Request描述类型是否必须错误返回码列表error_codeerror_desc1授权过期500服务器内部错误600账号被锁定10001手机号码不能为空10002密码不能为空10003验证码不能为空10004平台类型不正确10005手机验证码不正确10006手机验证码已失效10007用户类型不正确10008
4、用户名不能为空10009原密码不能为空10010新密码不能为空10011原密码不正确10012经度不能为空10013纬度不能为空10014对象用户ID不能为空用户接口用户注册(user/signup)Request参数名类型是否必须描述mobileInt注册手机号.verify_codeString手机验证码passwordString密码platformString平台类型(ios,android)uidResponse参数名类型是否必须描述SessonId (TOKEN)sidExampleRequestResponse用户登录(user/signin)方法GET/POSTRequest参
5、数名类型是否必须描述mobileusernamepasswordt ype密码（type=l时必须）用户类型1：手机号2: QQ3：微信4：微博N用户名（type=2、3、4时必须）NYplatformStringY平台类型(ios,android)ResponseuserArrayY用户信息idIntY用户ID参数名类型是否必须描述sidStringYSessonId (TOKEN)用户角色user_groupIntY1：普通用户2：专车车主nicknameStringY昵称emailStringY邮箱mobileStringY手机号nameStringY姓名usernameStringY用户名性别genderIntY0：男1：女ageIntY年龄birthdayStringY出生日期avatarStringY头像URLjoined_atStringY注册时间ExampleRequestResponse优惠券接口我的优惠券(coupon/mycoupon)
API接口设计说明书
