API接口申请审批报告~书.doc

《API接口申请审批报告~书.doc》由会员分享，可在线阅读，更多相关《API接口申请审批报告~书.doc（13页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、|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|引言编写目的说明编写这份用户手册的目的，指出预

2、期的读者。背景说明：a 这份用户手册所描述的软件系统的名称；b 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中心。定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。参考资料列出有用的参考资料，如：a 本项目的经核准的计划任务书或合同、上级机关的批文；b 属于本项目的其它已发表的文件；c 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。|综述统一的输入输出参数Request参数名 类型 是否必须 描述language String Y cn:中文，en:英文，t

3、h：泰文uid Int Y 用户 ID. sid String Y SessonId（TOKEN）（不需要登录就能调用的接口、注册接口、登录接口，uid 和 sid 两个参数不需要输入）Response参数名 类型 是否必须 描述succeed Int Y 0：失败，1：成功error_code Int N 错误码error_desc String N 错误消息必须登录才能访问的接口接口名称 描述user/signout 用户退出user/photoupload 照片上传user/changeprofile 修改用户资料user/changepassword 修改用户密码user/info 获

4、取用户信息|错误返回码列表error_code error_desc1 授权过期500 服务器内部错误600 账号被锁定10001 手机号码不能为空10002 密码不能为空10003 验证码不能为空10004 平台类型不正确10005 手机验证码不正确10006 手机验证码已失效10007 用户类型不正确10008 用户名不能为空10009 原密码不能为空10010 新密码不能为空10011 原密码不正确10012 经度不能为空10013 纬度不能为空10014 对象用户 ID 不能为空|用户接口用户注册（user/signup ）接口 user/signup描述 用户注册验证 Session

5、方法 GET/POSTRequest参数名 类型 是否必须 描述mobile Int Y 注册手机号. verify_code String Y 手机验证码password String Y 密码platform String Y 平台类型（ios,android ）ResponseExampleRequest“mobile“: “15866667777“,“verify_code“: “123456“,“password“: “111111“,“platform“: “android“参数名 类型 是否必须 描述sid String Y SessonId（TOKEN）uid Int Y 用户

6、 ID|Response1.错误情况“succeed“: 0,“error_code“: 10006,“error_desc“: “手机验证码已失效“2.正常情况“sid“: “sess_573d27b370dc7“,“uid“: “28“,“succeed“: 1用户登录（user/signin）接口 user/signin描述 用户登录验证 Session方法 GET/POSTRequest参数名 类型 是否必须 描述mobile Int N 注册手机号. (type=1 时必须)username String N 用户名(type=2、3、4 时必须)password String N

7、密码(type=1 时必须)type Int Y 用户类型|1：手机号2：QQ3：微信4：微博platform String Y 平台类型（ios,android ）Response参数名 类型 是否必须 描述sid String Y SessonId（TOKEN）user Array Y 用户信息id Int Y 用户 IDuser_group Int Y用户角色1：普通用户2：专车车主nickname String Y 昵称email String Y 邮箱mobile String Y 手机号name String Y 姓名username String Y 用户名gender Int Y性别0：男1：女age Int Y 年龄birthday String Y 出生日期avatar String Y 头像 URLjoined_at String Y 注册时间ExampleRequest