app接口文档模板

1、XXX 项目 APP 接口文档首页 3首页 3加载更多商品 7用户注册 9注册 9发送手机验证码 11用户中心 12登录 12登出 14原产品 15产品列表 15产品详情 18分类树 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:

2、10partner 和 key 为常量head：头信息，用于安全校验，参数固定为partner、 key、 mdkey 三项， mdkey 随不同接口而变，头部信息校验错误统一返回，错误码分三种：1： PARTNER 有误head: code: C0004,msg: PARTNER 验证失败！ 2：KEY 有误head: code: C0005,msg: KEY 验证失败！ 3： MD5 加密错误head: code: C0001,msg: 请求验证失败！ para：请求体，客户端请求所需要传入的参数，依据不同接口而定 result：结果集，主要用于分页首页URL ： http:/app.xx

3、 输入参数： request=head: partner: 77b872abfe1260053032219354882d91,key: ldingadmin,mdkey: md5(partner+key),result: start: 0, /从第 0 条数据开始，(首页此项参数只能为 0)count: 20 /总共返回 20 条数据，(即每页显示数量，由客户端自定) 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者 KEY不可

4、空ldingadminmdkeyStringMD5 加密字符 md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caresultstartInt分页数据开始标示 id可 空（ 固 定为 0）0countInt返回总数据条数可 空（ 为 空 时采 用 系 统默 认 值 20）20返回码描述：错误码： 参考头部信息校验统一错误码 正确返回：head: code: 10000, msg: 数据获取成功,para: banner: ad_id: 2,ad_name: 首页轮转 2,pic: /data/files/m

5、all/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: 1200,height: 475,cate: cate_id: 1216

6、,cate_name: 女装 ,cate_ename: WOMEN,cate_banner: /data/files/mall/category/2015/06/201506100640272205.jpg,image_size: width: 460,height: 300,cate_id: 1217,cate_name: 男装 ,cate_ename: MEN,cate_banner: /data/files/mall/category/2015/06/201506081359262711.jpg,image_si

7、ze: width: 460,height: 300,pic: pic_id: 311,pic_name: 小女孩柠檬汽水 ,price: 25.00,pic_url: /data/files/store_238/pic/2015/06/201506160937045578.jpg,collects: 1,views: 0,sales: 0,image_size: width: 2063,height: 2063,love: true / 是否关注， true 已关注， false 未关注,pic_id: 314,pic_name: 小女孩漫漫花事 ,pr

8、ice: 35.00,pic_url: /data/files/store_238/pic/2015/06/201506161014059499.jpg,collects: 1,views: 0,sales: 0,image_size: width: 2244,height: 3488,love: false,products: product_id: 176,product_name: 三脚猫原创手工皮革 染色单肩包 手工定制 , price: 400.00,image_url: /data/files/store_

9、90/openshop/product_pic.JPG, collects: 1,views: 0,sales: 0,image_size: width: 3000,height: 3000,love: true / 是否关注， true 已关注， false 未关注,product_id: 2066,product_name: H.Cstudio 黑白拼色走秀款真丝缎面 ,price: 499.00,image_url: /data/files/store_79/product/2015/06/201506150339342394.jpg, collec

10、ts: 0,views: 0,sales: 0,image_size: width: 515,height: 774,love: false,result: start: 1,count: 20 正确返回码说明：参数 参数名称 类型（长度范围） 参数说明 样例headcodeString返回码， 10000 成 功，其他值失败head: code: 10000,msg: 恭喜，注册成功！ msgString返回码提示信息parabannerArray首页轮转如上返回码描述 - 正确返回cateArray一级分类picArray热门图片productsArray人气商品resultstartin

11、t此次请求， 分页数据开始标示 idresult: start: 0,countint此次请求， 返回总 count: 20 数据条数 加载更多商品URL ： /index.php/index/load_more 输入参数： request=head: partner: 77b872abfe1260053032219354882d91,key: ldingadmin,mdkey: md5(partner+key),result: start: 21, /从第 21 条数据开始count: 20 /总共返回 20 条数据，(即每页显示数量) 输入参数说明：参

12、数 参数明细类型（长度范围） 参数说明 是否可空 样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyStringString合作者 KEYMD5 加密字符md5(partner+key)不可空ldingadmina4bf5363f7bd76c5a4975b75f19f63camdkey不可空resultstartInt分页数据开始标示id不可空21countInt返回总数据条数可 空（ 为 空 时采 用 系 统默 认 值 20）20返回码描述：错误码： 参考头部信息校验统一错误码 正确返回：head: code: 10

13、000,msg: 数据获取成功,para: products: product_id: 176,product_name: 三脚猫原创手工皮革 染色单肩包 手工定制 , price: 400.00,image_url: /data/files/store_90/openshop/product_pic.JPG,collects: 1,views: 0,sales: 0,image_size: width: 3000,height: 3000,love: true / 是否关注， true 已关注， false 未关注,product_id: 2066,pr

14、oduct_name: H.Cstudio 黑白拼色走秀款真丝缎面 , price: 499.00,image_url: /data/files/store_79/product/2015/06/201506150339342394.jpg, collects: 0,views: 0,sales: 0,image_size: width: 515,height: 774,love: false,result: start: 21,count: 20 正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码， 10000 成

15、head: 功，其他值失败code: 10000,msgString返回码提示信息msg: 恭喜，注册成功！ parabannerArray首页轮转如上返回码描述 - 正确返回cateArray一级分类picArray热门图片productsArray人气商品resultstartint此次请求， 分页数result: 据开始标示 idstart: 21,countint此次请求， 返回总count: 20数据条数用户注册注册URL ： /index.php/register/reg 输入参数：request=head: partner: 77b872ab

16、fe1260053032219354882d91,key: ldingadmin,mdkey: md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key) ,para: mobile: 注册手机号 ,pwd: 密码 ,cpwd: 确认密码 ,sms_captcha: 手机接收的验证码 ,nick_name: 昵称 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例String合作者 IDa4bf5363f7bd76c5a4975b75f19f63caheadpartner不可空keyString合作者 KEYldingadmin不可

17、空mdkeyStringMD5 加密字符 md5(mobile+pwd+c pwd+sms_captcha+ nick_name+partner+ key)不可空a4bf5363f7bd76c5a4975b75f19f63caparauser_name(mobile)String用户名，目前为接收验证码手机号不可空usersms_captchaString手机验证码不可空678459pwdString密码 6-20 位字符不可空123456cpwdString确认密码 6-20 位字 符不可空123456nick_nameString昵称可为空oheyou返回码描述： 错误码：head: co

18、de: E0003,msg: 注册验证失败 head: code: E0001,msg: 用户名已存在！head: code: E0001,msg: 两次密码不一致正确返回：head: code: 10000,msg: 恭喜，注册成功！,para: user_name: user,phone_mob: user,nick_name: oheyou,status: 1,user_id: 263正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码， 10000 成 功，其他值失败head: code: 10000,msgString返回码提示信息msg: 恭喜

19、，注册成功！ parauser_nameString(5-25)注册用户名para: user_name: user,phone_moString(11)注册手机号phone_mob: user,bnick_name: oheyou,nick_namString昵称status: 1,euser_id: 263statusint状态user idint注册用户 id发送手机验证码URL ： /index.php/register/send_sms_captcha 输入参数：request=head: partner: 77b872abfe126005303

20、2219354882d91,key: ldingadmin,mdkey: md5(partner+key),para: mobile: 用户手机号 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63keyString合作者 KEY不可空ldingadminmdkeyStringMD5 加密字符md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63paramobileString接收验证码手机号不可空user返回码描述： 错误码：

21、head: code: E0005, msg: 手机号码不正确 正确返回：head: code: 10000,msg: 短信发送成功 真确返回码说明：参数 参数名称 类型（长度范围） 参数说明 样例headcodeString返回码， 10000 成head: 功，其他值失败code: 10000,msgString返回码提示信息msg: 短信发送成功用户中心登录URL ： /index.php/user/login 输入参数：request=head: partner: 77b872abfe1260053032219354882d91, key: ldi

22、ngadmin,mdkey: md5(user_name+pwd+partner+key),para: user_name: 用户名pwd: 密码 输入参数说明：参数参数明细类型（长度范围） 参数说明 是否可空 样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者 KEY不可空ldingadminmdkeyStringMD5 加密字符 md5(user_name+pw d+partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caparauser_name(mobil

23、e)pwdString用户名不可空userString密码 6-20 位字符不可空123456返回码描述错误码：head: code: E0003,msg: 用户名或密码错误！ 正确返回：head: code: 10000,msg: 登录成功 ,para: user_id: 76, user_name: user, nick_name: oheyou, gender: 0, im_qq: 0, email: 978104192, points: 0,portrait: /data/files/usr/76/2015/05/20150514044

24、8321718.jpg, logins: 0,last_login: 1435226105,follow: 4, /关注数量fans: 1, /粉丝数量loves: 12, /喜欢数量(产品，图片，商品)collects: 0 / 店铺收藏数量正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码， 10000 成 功，其他值失败head: code: 10000,msgString返回码提示信息msg: 登录成功！ parauser_idint用户 idpara: user_id: 76, user_name: user,User_nam eString(

25、5-25)用户名nick_name: oheyou,gender: 0,nick_namString昵称eim_qq: 0,email: 978104192,genderint性别im_qqString用户 QQ 号points: 0,portrait:emailString用户邮箱/data/files/usr/76/2015/05/2015051404483pointsint积分21718.jpg,portraitString头像地址logins: 0,loginsint登录次数last_login: 1435226105,last_log

26、inString最 后一 次登录 时 间戳follow: 4,/关注数量fans: 1, /粉丝数量follow关注数量1loves: 12, / 喜欢数量（产品，图片，商品） collects: 0 / 店铺收藏数量fans粉丝数量2loves喜欢（产品，图片，商品）数量3collects店铺收藏数量4登出URL ： /index.php/user/login_out 输入参数：request=head: partner: 77b872abfe1260053032219354882d91,key: ldingadmin,mdkey: md5(partne

27、r+key) 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者 ID合作者 KEY不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString不可空ldingadminmdkeyStringMD5 加密字符 md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63ca返回码描述 错误码： 无 正确返回： head: code: 10000,msg: 登出成功！ 正确返回码说明：参数参数名称类型（长度范围） 参数说明 样例headcodeString返回码， 10000 成

28、 功，其他值失败head: code: 10000,msg: 登出成功！ msgString返回码提示信息原产品产品列表URL ： /index.php/product 输入参数：request=head: partner: 77b872abfe1260053032219354882d91,key: ldingadmin,mdkey: md5(cid+order+partner+key),para: cid: 分类 id,order: 排序 ,result: start: 0, count: 20, 输入参数说明：参数 参数明细类型（长度范围） 参数说明

29、是否可空 样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者 KEY不可空ldingadminmdkeyStringMD5 加密字符 md5(cid+order+part ner+key)a4bf5363f7bd76c5a4975b75f19f63ca不可空paracidint分类 id不可空1216orderint排序：1：添加时间倒序 2：添加时间顺序 3：销量倒序 4：销量顺序 5：价格倒序 6：价格顺序 7：人气倒序 8：人气顺序可空（ 为空 时 默认为1）1resultstartint数据起

30、始 id0不可空countint返回总数据条数可空（ 为空 时 采 用默 认 值 20）20返回码描述错误码：参考头部信息校验统一错误码正确返回：head: code: 10000,msg: 数据获取成功 ,para: product_id: 2073,product_name: HC STUDIO 黑色羊毛 西装裤 ,add_time: 1434346771,price: 219.00,min_price: 219.00,max_price: 219.00,store_id: 79,store_name: HC 定制工作室 ,image_url: /da

31、ta/files/store_79/product/2015/06/201506230847457013.png, view: 0, / 浏览量collects: 2, / 收藏量carts: 0, /加入购物车量orders: 0, /下单量sales: 0, / 销售量comments: 0, / 评论量love: false / 是否喜欢,product_id: 2071,product_name: HC STUDIO 优雅锦缎提花褶半身裙 ,add_time: 1434346569,price: 249.00,min_price: 249.00,max_price: 249.00,st

32、ore_id: 79,store_name: HC 定制工作室 ,image_url: /data/files/store_79/product/2015/06/201506190721567528.jpg, view: 0,collects: 0,carts: 0,orders: 0,sales: 0,comments: 0, love: false,result: start: 0,count: 20正确返回码说明：参数 参数名称 类型（长度范围） 参数说明 样例head: headcodeString返回码， 10000 成 功，其他值失败msgSt

33、ring返回码提示信息paraproduct_idint产品 idproduct_nameString(5-25)产品名称add_timeString添加时间priceint价格min_priceString最小价格max_priceString最大价格store_idint店铺 idstore_nam eString店铺名称Image urlint登录次数code: 10000, msg: 登录成功！ para: product_id: 2073,product_name: HC STUDIO 黑色羊毛 西装 裤,add_time: 1434346771,price: 219.00,min_

34、price: 219.00,max_price: 219.00,store_id: 79,store_name: HC 定制工作室 , image_url:/data/files/store_79/product/2015/06/2015 06230847457013.png,view: 0, / 浏览量collects: 2, /收藏量carts: 0, / 加入购物车量orders: 0, / 下单量sales: 0, / 销售量comments: 0, / 评论量love: false / 是否喜欢产品详情URL ： http:/app.xxxxx.

35、com/index.php/product/detail 输入参数：request=head: partner: 77b872abfe1260053032219354882d91,key: ldingadmin,mdkey: md5(product_id+partner+key),para: product_id: 产品 id,result: / 用于评价和咨询start: 0,count: 20, 输入参数说明：参数 参数明细类型（长度范围） 参数说明 是否可空 样例headpartnerString合作者 ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeySt

36、ring合作者 KEY不可空ldingadminmdkeyStringMD5 加密字符 md5(product_id+par tner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caparaproduct_idint产品 id不可空134resultstartint数据起始 id可空0countint返回总数据条数可空（ 为空 时 采 用默 认 值 20）20返回码描述错误码：参考头部信息校验统一错误码正确返回：head: code: 10000,msg: 数据获取成功,para: product_id: 134,product_name: poly( 测试专用

37、 ),price: 0.01,default_image_id: 616, / 商品主图 id/商品主图地址image_url: /data/files/store_76/openshop/product_pic.jpg, content: 啦啦啦啦啦啦 , /商品详情tags: /商品标签 连衣裙 ,雪纺 ,真丝 ,飘逸,brand_id: null, / 商品品牌 idbrand_name: null, / 商品品牌名称brand_logo: null, /商品品牌 logostore_id: 75, /店铺 idstore_name: awesome

38、, / 店铺名称store_type: 1, / 店铺类别 1：个人 2：公司apply_type: seller, / 店铺申请类型 seller：供应商 designer：设计师description: null, / 店铺简介store_collects: 0, /店铺收藏量store_sales: 5, /店铺销售量views: 0, /商品浏览量carts: 7, /商品加入购物车量collects: 2, /商品喜欢量sales: 6, / 商品销售量comments: 0, / 商品评论量orders: 8, /商品下单量product_loved: false, /是否喜欢过此

39、商品（用户未登录一律返回false）store_collected: false, /是否收藏过此店铺（用户未登录一律返回false）spec_text: /商品规格描述spec_id: 80,spec_name: 颜色 ,is_color: 0,values: spec_val_id: 23,sval_text: 白色 ,spec_val_text: 白色 ,spec_val_id: 24,sval_text: 红色 ,spec_val_text: 红色 , spec_id: 77, spec_name: 尺码 , is_color: 0, values: spec_val_id: 15, sval_text: M, spe