app接口文档模板.doc

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: 10 head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，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: ldingadmin, mdkey: md5(partner+key), result: start: 0, /从第0条数据开始，（首页此项参数只能为0） count: 20 /总共返回20条数据，（即每页显示数量，由客户端自定） 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空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/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: 1200, height: 475 , cate: cate_id: 1216, 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_size: 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: 小女孩漫漫花事, price: 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_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, collects: 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人气商品resultstartint此次请求，分页数据开始标示idresult: start: 0, count: 20 countint此次请求，返回总数据条数加载更多商品URL：/index.php/index/load_more输入参数：request= head: partner: 77b872abfe1260053032219354882d91, key: ldingadmin, mdkey: md5(partner+key), result: start: 21, /从第21条数据开始 count: 20 /总共返回20条数据，（即每页显示数量） 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caresultstartInt分页数据开始标示id不可空21countInt返回总数据条数可空（为空时采用系统默认值20）20返回码描述：错误码：参考头部信息校验统一错误码正确返回： head: code: 10000, 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, product_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成功，其他值失败head: code: 10000, msg: 恭喜，注册成功！ msgString返回码提示信息parabannerArray首页轮转如上返回码描述 - 正确返回cateArray一级分类picArray热门图片productsArray人气商品resultstartint此次请求，分页数据开始标示idresult: start: 21, count: 20 countint此次请求，返回总数据条数用户注册注册URL：/index.php/register/reg输入参数：request= head: partner: 77b872abfe1260053032219354882d91, key: ldingadmin, mdkey: md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key) , para: mobile: 注册手机号, pwd: 密码, cpwd: 确认密码, sms_captcha: 手机接收的验证码, nick_name: 昵称 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caparauser_name(mobile)String用户名，目前为接收验证码手机号不可空usersms_captchaString手机验证码不可空678459pwdString密码6-20位字符不可空123456cpwdString确认密码6-20位字符不可空123456nick_nameString昵称可为空oheyou返回码描述：错误码： head: code: 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, msg: 恭喜，注册成功！ msgString返回码提示信息parauser_nameString(5-25)注册用户名para: user_name: user, phone_mob: user, nick_name: oheyou, status: 1, user_id: 263 phone_mobString(11)注册手机号nick_nameString昵称statusint状态user_idint注册用户id发送手机验证码URL：/index.php/register/send_sms_captcha输入参数：request= head: partner: 77b872abfe1260053032219354882d91, key: ldingadmin, mdkey: md5(partner+key) , para: mobile: 用户手机号 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63keyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63paramobileString接收验证码手机号不可空user返回码描述：错误码： head: code: E0005, msg: 手机号码不正确 正确返回： head: code: 10000, msg: 短信发送成功 真确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码，10000成功，其他值失败head: code: 10000, msg: 短信发送成功 msgString返回码提示信息用户中心登录URL：/index.php/user/login输入参数：request= head: partner: 77b872abfe1260053032219354882d91, key: ldingadmin, mdkey: md5(user_name+pwd+partner+key) , para: user_name: 用户名, pwd: 密码 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(user_name+pwd+partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caparauser_name(mobile)String用户名不可空userpwdString密码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/201505140448321718.jpg, logins: 0, last_login: 1435226105, follow: 4, /关注数量 fans: 1, /粉丝数量 loves: 12, /喜欢数量（产品，图片，商品） collects: 0 /店铺收藏数量 正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码，10000成功，其他值失败head: code: 10000, msg: 登录成功！ msgString返回码提示信息parauser_idint用户idpara: 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/201505140448321718.jpg, logins: 0, last_login: 1435226105, follow: 4, /关注数量 fans: 1, /粉丝数量 loves: 12, /喜欢数量（产品，图片，商品） collects: 0 /店铺收藏数量 User_nameString(5-25)用户名nick_nameString昵称genderint性别im_qqString用户QQ号emailString用户邮箱pointsint积分portraitString头像地址loginsint登录次数last_loginString最后一次登录时间戳follow关注数量1fans粉丝数量2loves喜欢（产品，图片，商品）数量3collects店铺收藏数量4登出URL：/index.php/user/login_out输入参数：request= head: partner: 77b872abfe1260053032219354882d91, key: ldingadmin, mdkey: md5(partner+key) 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63ca返回码描述错误码：无正确返回： head: code: 10000, msg: 登出成功！ 正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码，10000成功，其他值失败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, 输入参数说明：参数参数明细类型（长度范围）参数说明是否可空样例headpartnerString合作者ID不可空a4bf5363f7bd76c5a4975b75f19f63cakeyString合作者KEY不可空ldingadminmdkeyStringMD5加密字符md5(cid+order+partner+key)不可空a4bf5363f7bd76c5a4975b75f19f63caparacidint分类id不可空1216orderint排序：1：添加时间倒序2：添加时间顺序3：销量倒序4：销量顺序5：价格倒序6：价格顺序7：人气倒序8：人气顺序可空（为空时默认为 1）1resultstartint数据起始id不可空0countint返回总数据条数可空（为空时采用默认值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: /data/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, store_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 正确返回码说明：参数参数名称类型（长度范围）参数说明样例headcodeString返回码，10000成功，其他值失败head: code: 10000, msg: 登录成功！ msgString返回码提示信息paraproduct_idint产品idpara: 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: /data/files/store_79/product/2015/06/201506230847457013.png, view: 0, /浏览量 collects: 2, /收藏量 carts: 0, /加入购物车量 orders: 0, /下单量 sales: 0, /销售量 comments: 0, /评论量 love: false /是否喜欢 product_nameString(5-25)产品名称add_timeString添加时间priceint价格min_priceString最小价格max_priceString最大价格store_idint店铺idstore_nameString店铺名称Image_urlint登录次数产品详情URL：/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不可空a4bf5363f7b