app接口文档模板..docx

XXX 项目 APP 接口文档 TOC \o "1-5" \h \z \o "Current Document" 首页 3 首页 3 \o "Current Document" 加载更多商品 7 \o "Current Document" 用户注册 9 \o "Current Document" 注册 9 \o "Current Document" 发送手机验证码 11 \o "Current Document" 用户中心 12 \o "Current Document" 登录 12 \o "Current Document" 登出 14 \o "Current Document" 原产品 15 \o "Current Document" 产品列表 15 \o "Current Document" 产品详情 18 \o "Current Document" 分类树 22 备注： 23 注： 传参一律用 post 方式， key=request, value 为一串 json 格式字符串，格式如： request={ "head": { "partner": "xxxxxxxxxxxxxxxxxxxxxxx", "key": "xxxxxxxxx", "mdkey": "xxxxxxxxxxx" }, "para": { "user_name": "user_name", "pwd": "123456" }, "result": { "start": 0, "count": 10 } } partner 和 key 为常量head：头信息，用于安全校验，参数固定为 partner、key、mdkey partner 和 key 为常量 头部信息校验错误统一返回，错误码分三种： 1： PARTNER 有误 { "head": { "code": "C0004", "msg": "PARTNER 验证失败！ " } } 2： KEY 有误 { "head": { "code": "C0005", "msg": "KEY 验证失败！ " } } 3： MD5 加密错误 { "head": { "code": "C0001", "msg": " 请求验证失败！ " } } para：请求体，客户端请求所需要传入的参数，依据不同接口而定 result :结果集，主要用于分页 首页 URL : 输入参数： request={ "head": { "partner": "77b872abfe1260053032219354882d91", "key": "Idingadmin", "mdkey": md5(partner+key) }, "result": { "start": 0, //从第0条数据开始，(首页此项参数只能为 0) "count": 20 〃总共返回20条数据，(即每页显示数量，由客户端自定) } } 输入参数说明: 参数 参数明细 类型（长度范围） 参数说明 是否可空 样例 head part ner Stri ng 合作者ID 不可空 a4bf5363f7bd76c5a4975b75f19f63ca key Stri ng 合作者KEY 不可空 ldi ngadmin mdkey Stri ng MD5加密字符 md5(part ner+key) 不可空 a4bf5363f7bd76c5a4975b75f19f63ca result start Int 分页数据开始标示 id 可空（固 定为0） 0 cou nt Int 返回总数据条数 可空（为 空时采用 系统默认 值20） 20 返回码描述： 错误码： 参考头部信息校验统一错误码 正确返回： { "head": { "code": "10000", "msg":"数据获取成功 }, "para": { "banner": [ { "ad_id": "2", "ad_name": " 首页轮转 2", "pic": " /data/files/mall/ad/1434512150.jpg", "link": " /index.php?app=search&act=products&cid=1312", "image_size": { "width": 1200, "height": 475 } }, { "ad_id": "3", "ad_name": " 首页轮转 3", "pic": " /data/files/mall/ad/1434523823.png", "link": " /joinus/", "image_size": { "width"