




已阅读5页,还剩8页未读, 继续免费阅读
版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
.XXAPI接口设计说明书公司2016年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: 2003, 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.
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 2025国家农业农村部食物与营养发展研究所综合办公室助理招聘4人模拟试卷及完整答案详解1套
- 2025河南信阳市人民医院招聘合同制人员2人模拟试卷及1套参考答案详解
- 2025贵州省第三人民医院第十三届贵州人才博览会引才12人考前自测高频考点模拟试题有答案详解
- 2025贵州省农业科学院引进高层次人才16人模拟试卷及参考答案详解一套
- 2025北京市房山区燕山教育委员会所属事业单位第一批招聘教师30人模拟试卷有答案详解
- 2025年沙市区招商公司公开招聘职员6人考前自测高频考点模拟试题及答案详解(易错题)
- 2025年河北保定市公安局招聘警务辅助人员32人模拟试卷附答案详解(突破训练)
- 2025辽宁抚顺新抚钢有限责任公司招聘拟聘用人员考前自测高频考点模拟试题及答案详解(历年真题)
- 2025包头市东河区机关所属事业单位春季引进人才51人考前自测高频考点模拟试题有完整答案详解
- 2025昆明市盘龙区滇源街道中心卫生院第二次招聘(2人)模拟试卷及答案详解(必刷)
- 2025年汽车驾驶员(高级)理论考试试题及答案
- 2025年幼儿园保健医考核试题及答案
- 乌兹别克语自学课件
- 《“盛世华诞”国庆主题》课件
- 2025年江苏卫生健康职业学院单招《语文》检测卷
- 物流客服培训课件
- 川教版四年级上册《生命.生态.安全》全册教案(及计划)
- 华为技术有限公司企业简称2023环境、社会与公司治理报告:高科技行业ESG绩效与NGO监督
- 县级医疗重点专科建设项目申请书范文
- 穿心莲栽培技术
- 和奶奶一起做散步公开课
评论
0/150
提交评论