API接口设计说明书书.docVIP

XXAPI 接口设计说明书 公司 2016年11月25日  文档管理信息表 主题 XX api接口设计说明书 版本 V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人 修改时间 修改内容 创建 目 录 TOC \o 1-3 \h \z \u 文档变更记录表 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 参数名 类型 是否必须 描述 language String Y cn:中文，en:英文，th：泰文 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 获取用户信息 错误返回码列表 error_code error_desc 1 授权过期 500 服务器内部错误 600 账号被锁定 10001 手机号码不能为空 10002 密码不能为空 10003 验证码不能为空 10004 平台类型不正确 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 参数名 类型 是否必须 描述 sid String Y SessonId（TOKEN） uid Int Y 用户ID Example Request { mobile: verify_code: 123456, password: 111111, platform: android } Response 1.错误情况 { succeed: 0, error_code: 10006, error_desc: 手机验证码已失效 } 2.正常情况 { sid: sess_573d27b370dc7, uid: 28, succeed: 1 } 用户登录（user/signin） 接口 user/signin 描述 用户登录 验证 Session 方法 GET/POST Request 参数名 类型 是否必须 描述 mobile Int N 注册手机号. (type=1时必须) username String N 用户名