- 1、本文档共15页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
XXAPI
接口设计说明书
公司
2016年11月25日
文档管理信息表
{
主題
XXapi接口设计说明书
版本
内容
关键字
}
参考文档
创建时间
创建人
最新发布日期
文档变更记录表
修改人
修改时间
修改内容
创建
TOC\o1-5\h\z\oCurrentDocument文档变更记录表 3
目录 1
弓I言 1
\oCurrentDocument编写目的 1
\oCurrentDocument背景 1
\oCurrentDocument定义 1
\oCurrentDocument参考资料 1
\oCurrentDocument综述 2
\oCurrentDocument统一的输入输出参数 2
\oCurrentDocument必须登录才能访问的接口 2
\oCurrentDocument错误返回码列表 3
\oCurrentDocument用户接口 4
\oCurrentDocument用户注册(user/signup) 4
\oCurrentDocument用户登录(user/signin) 5
\oCurrentDocument优惠券接口 9
\oCurrentDocument我的优惠券(coupon/mycoupon) 9
引言
编写目的
{说明编写这份用户手册的目的,指出预期的读者。}
背景
{说明:
这份用户手册所描述的软件系统的名称;
该软件项目的任务提出者、开发者、用户(或首批用户)及安装此软件的的计算站中心。}
定义
{列出本文件中用到的专门术语的定义和外文首字母组词的原词组。}
参考资料
{列出有用的参考资料,如:
本项目的经核准的计划任务书或合同、上级机关的批文;
属于本项目的其它已发表的文件;
本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。}
综述
统一的输入输出参数
Request
是否必须
描述
(不需要登录就能调用的接口、注册接口、登录接口,uid和sid两个参数不需要输入)
Response
参数名
描述
必须登录才能访问的接口
接口名称
描述
user/signout
用户退出
user/photoupload
照片上传
user/changeprofile
修改用户资料
user/changepassword
修改用户密码
user/info
获取用户信息
错误返回码列表
error_code
error_.desc
1
授权过期
500
服务器内部错误
600
账号被锁定
10001
手机号码不能为空
10002
密码不能为空
10003
验证码不能为空
10001
平台类型不正确
10005
手机验证码不正确
10006
手机验证码巳失效
10007
用户类型不正确
10008
用户名不能为空
10009
原密码不能为空
10010
新密码不能为空
10011
原密码不正确
10012
经度不能为空
10013
纬度不能为空
10014
对象用户ID不能为空
用户接口
用户注册(user/signup)
接口
user/signup
描述
用户注卅
脸证
Session
方法
GET/POST
Request
歩数名
类型
是否必须
描述
mobile
Int
Y
注哥手机号.
verify_code
String
Y
手机验证码
password
String
Y
密码
platform
String
Y
平台类型(ios,android)
Response
参数名
描述
Example
Request
mobile”::
wverify_codeM:*123456\
password?:^llllir,
platform■:android
Response
1?错误情况
{
succeed:0.
nerror_codeM:
10006.
eiTor_desc:
”手机验证码已失效“
2?正常情况
{
?sid?:Msess_573d27b370dc7\
?uid?:rt28\
succeed:1
用户登录(user/signin)
接口 user/signin
描述
用户登录
验证
Session
方法
GET/POST
Request
参数名
类型
是否必须
描述
mobile
Int
\
注昂手机号.(type=4时必须)
username
String
N
用户名(type=2.3、4时必须)
password
String
N
密码(type=l时必须)
用户类型
1:手机号
ty
您可能关注的文档
- Bobaths法在偏瘫中的应用.ppt
- Blackboard平台功能简介.doc
- Biotage快速制备色谱讲义.docx
- BIM应用策划(最新文档).docx
- BIM+助力交通基础设施行业数字化转型.pptx
- b4试卷模板(最新文档).doc
- Auto_CAD入门实用教程.pptx
- At-Christmas-(桂婷婷2020.12)(最新文档).ppt
- AS NZS 2293.1-2018-应急照明-翻译稿-20211217.pdf
- API模型(最新文档).ppt
- 黑龙江佳木斯市(新版)2024小学语文苏教版小升初真题(冲刺卷)完整试卷(含答案).docx
- 黑龙江黑河市(新版)2024小学语文苏教版小升初真题(拓展卷)完整试卷(含答案).docx
- 黑龙江鹤岗市(新版)2024小学语文统编版(五四制)小升初模拟(综合卷)完整试卷(含答案).docx
- 黑龙江伊春市(新版)2024小学语文统编版(五四制)小升初考试(提分卷)完整试卷(含答案).docx
- 黑龙江佳木斯市(新版)2024小学语文部编版小升初核心能力评测(强化卷)完整试卷(含答案).docx
- 黑龙江双鸭山市(新版)2024小学语文统编版(五四制)小升初考试(综合卷)完整试卷(含答案).docx
- 黑龙江大兴安岭地区(新版)2024小学语文人教版小升初核心能力评测(评估卷)完整试卷(含答案).docx
- 黑龙江哈尔滨市(新版)2024小学语文苏教版小升初考试(强化卷)完整试卷(含答案).docx
- 黑龙江大庆市(新版)2024小学语文苏教版小升初测试(自测卷)完整试卷(含答案).docx
- 黑龙江哈尔滨市(新版)2024小学语文苏教版小升初核心能力评测(自测卷)完整试卷(含答案).docx
最近下载
- 小学校创客及人工智能教育典型案例.docx
- 变电运行试题题库.pdf VIP
- 2023年新疆大学软件工程专业《数据结构与算法》科目期末试卷B(有答案).docx VIP
- JC08心理咨询技能单科作业题(新版教材考生通用_202305月考生适用).pdf
- 七人学生小品《如此课堂》剧本台词手稿.doc
- 部级基础教育精品课PPT模板.pptx
- 采埃孚商用车及工程机械产品专用油品手册.PDF
- QGDW10270-2017-220kV及110(66)kV输变电工程可行性研究内容深度规定.pdf
- 2022知到答案 军事理论(同济大学) 智慧树满分章节测试答案.docx
- 口腔CBCT管理制度-操作规程.docx
文档评论(0)