红孩子客户端手机接口.doc

二、通信接口2.1 公共数据部分采用短链接的http协议进行通讯,提交方式为post和get两种方式，返回的数据类型为JSON2.1.1 公共头部所有接口请求均包含以下头信息(Http Request Header)参数名称类型是否必须参数值示例说明appkeyStringY123456软件身份keyudidStringYudid or imei手机客户端的唯一标识osStringYIphone os操作系统名称osversionStringY5.0操作系统版本appversionStringY1.0.0APP版本sourceidStringYYek_test推广IDverStringY0.9通讯协议版本useridStringN12345用户IDusersessionStringNCbaq4fxvb登陆后得到的用户唯一性标识uniqueStringNxvbvsfsgdsg激活后得到的设备唯一性标识所有通信均无加解密信息，参数解释：appkey身份标识，服务器端进行识别udid客户端硬件标识osios& android& WM7osversion5.0appversionapp发布版本sourceidveruserid登录完之后传客户端usersession登录标识uniqueapp自动激活后服务器返回标识2.2.2 一些规范a错误码返回格式： response: error, error: text: 用户名不存在 btype类型：typedescription1限时抢购2促销快报3新品上架4热门单品5推荐品牌c排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_downd商品列表有很多种商品列表页，逻辑大同小异，但为了定位和区分统计，采用不同URL请求e请求类型：一般情况下抓取数据的请求，皆为GET和服务器有交互的请求，皆为POST2.2.3 请求host初定请求host为2.2 首页发送方式发送URL备注GET/home参数名称描述样例无服务器返回数据描述样例模块home_banner 轮转大图，点击进入专题商品列表页home_classlist 多功能列表，按顺序限时response: home home_banner: /轮转大图 320*125 id: 123, /专题id title: 活动1, /专题标题 pic: http:/localhost/1.png /专题图片URL , id: 124, title: 活动2, pic: http:/localhost/1.png , home_classlist: type: 1, /1为限时抢购 id: 123, /限时抢购ID title: 限时抢购, /description pic: http:/localhost/1.png /icon图片URL，点击进入/limitbuy , type: 2, /2为促销快报 title: 促销快报, pic: http:/localhost/2.png, /icon图片URL，点击进入/topic , type: 3, /3为新品上架 title: 新品上架, pic: http:/localhost/3.png, /icon图片URL，点击进入/newproduct , type: 4, /4为热门单品 title: 热门单品, pic: http:/localhost/4.png, /icon图片URL，点击进入/hotproduct , type: 5, /5为新品上架 title: 推荐品牌, pic: http:/localhost/5.png, /icon图片URL，点击进入/brand ,2.3 搜索2.3.1 搜索推荐发送方式发送URL备注GET/search/recommend参数名称描述样例无服务器返回数据描述样例搜索页面调用获取推荐搜索词搜索历史为本地的缓存response: searchrecommend, search_keywords: /CMS定义推荐关键词，如无为空 adidas, 361, nike 2.3.2 搜索商品列表发送方式发送URL备注GET/search参数名称描述样例keyword搜索关键字keyword=奶粉page第几页1pageNum每页多少个10orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例搜索商品列表页response: search,productlist: /搜索商品列表 id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, list_count:1500 /商品总数2.4 专题及品牌2.4.1 促销快报发送方式发送URL备注GET/topic参数名称描述样例page第几页1pageNum每页多少个8服务器返回数据描述样例 response: topic, topic : id: 专题活动ID, name: 专题活动名称, pic: 图片URL , id: 专题活动ID, name: 专题活动名称, pic: 图片URL 2.4.2 推荐品牌发送方式发送URL备注GET/brand参数名称描述样例无服务器返回数据描述样例CMS定制的推荐品牌 response: brand, brand: key:孕妈专区, /分区名称 value: id: 1201 /品牌编号 name: ain, /品牌名称 pic: /品牌图片URL, id: 1201 /品牌编号 name: ain, /品牌名称 pic: /品牌图片URL , key:营养食品, value: id: 1201 /品牌编号 name: ain, /品牌名称 pic: /品牌图片URL, id: 1201 /品牌编号 name: ain, /品牌名称 pic: /品牌图片URL 2.4.3 限时抢购发送方式发送URL备注GET/limitbuy参数名称描述样例page第几页pageNum每页个数orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例response: limitbuy,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLprice: 79, /会员价 limitprice: 78, /限时特价 lefttime: 3600 /剩余时间，单位为秒, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLprice: 79, /会员价 limitprice: 78, /限时特价 lefttime: 3600 /剩余时间，单位为秒 , list_count:1500 /商品总数2.4.4 新品上架发送方式发送URL备注GET/newproduct参数名称描述样例page第几页pageNum每页个数orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例response: newproduct,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , 1 /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 , list_count:1500 /商品总数2.4.5 热门单品发送方式发送URL备注GET/hotproduct参数名称描述样例page第几页pageNum每页个数orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例response: hotproduct,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 , list_count:1500 /商品总数2.4.6 专题商品列表发送方式发送URL备注GET/topic/plist参数名称描述样例page第几页1pageNum每页个数10id专题ID1234orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例response: topic_productlist,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 , list_count:1500 /商品总数2.4.7 品牌商品列表发送方式发送URL备注GET/brand/plist参数名称描述样例page第几页1pageNum每页个数10id品牌ID1234orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_down服务器返回数据描述样例response: brand_productlist,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 ,list_count:1500 /商品总数2.5 分类及详情2.5.1 分类请求发送方式发送URL备注GET/category参数名称描述样例version版本号1.0 服务器返回数据描述样例一次性返回所有分类信息，服务器端根据传入版本号进行对比，如果没有更新，则version返回原版本号。当isleafnode为true时，表示是树状结构的叶子节点，可点击进入商品列表。response:category,category:id:1,isleafnode:false,name:奶粉,parent_id:0,pic:,tag:孕妇奶粉 幼儿奶粉,id:11,isleafnode:false,name:孕妇奶粉,parent_id:1,pic:,id:111,isleafnode:false,name:三级分类111,parent_id:11,pic: ,id:12,isleafnode:false,name:1段,parent_id:1,pic:,tag:二级分类描述2所有的分类在一个大集合中，如左侧红色字体的格式,id:121,isleafnode:false,name:三级分类121,parent_id:12,pic:,tag:三级分类描述1,id:13,isleafnode:false,name:2段,parent_id:1,pic:,tag:二级分类描述3 ,version:2 response:category, category: id:1, name:奶粉, parent_id:0, pic:, tag:孕妇奶粉 幼儿奶粉 , id:11, name:孕妇奶粉, parent_id:1, pic:, tag:二级分类描述1 , id:111, name:三级分类111, parent_id:11, pic:, tag:三级分类描述1 , id:12, name:1段, parent_id:1, pic:, tag:二级分类描述2 , id:121, name:三级分类121, parent_id:12, pic:, tag:三级分类描述1 , id:13, name:2段, parent_id:1, pic:, tag:二级分类描述3 , version:2 version: 10, /当前服务器最新版本 response: category, category: /所有分类 id: 101, /分类ID name: 孕妈专区, /分类名称 pic: , /icon图片URL parant_id: 0, /父类ID isleafnode:false, /是否叶子节点 tag: /一级分类下展示的标签 妈妈内衣, 祛纹纤体, sub_category: id: 10101, /分类ID name: 孕产营养品奶粉, /分类名称 pic: , /icon图片URL parant_id: 0, /父类ID isleafnode:true /是否叶子节点，叶子节点可点击进入分类列表页 , id: 102, /分类ID name: 婴幼食品, /分类名称 pic: , /icon图片URL parant_id: 0, /父类ID isleafnode:false, /是否叶子节点 tag: /一级分类下展示的标签 奶粉辅食, 婴幼儿营养, sub_category: id: 10201, /分类ID name: 孕产营养品奶粉, /分类名称 pic: , /icon图片URL parant_id: 0, /父类ID isleafnode:true /是否叶子节点，叶子节点可点击进入分类列表页 2.5.2 商品列表发送方式发送URL备注GET/productlist参数名称描述样例page第几页1pageNum每页个数10cId分类ID1010101orderby排序sale_down(销量降序)，price_up(价格升序)，price_down(价格降序)，comment_down(评价降序)，shelves_down(上架降序)。目前只有价格有双向排序，其他都只有降序，其中默认为sale_downfilter筛选c182d2 (两个条件) c182d2t1 (三个条件)服务器返回数据描述样例response: category_productlist,productlist: id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 comment_count:23, /商品评论数加一个商品评论数属性, id: 1102539, /商品IDname: 雅培金装, /商品名称pic: , /商品图片URLmarketprice: 79, /市场价 price: 78, /会员价 comment_count:23, /商品评论数 ,list_count:1500 /商品总数,list_filter: /筛选属性key:颜色 /属性名称value: /属性值列表 id:t1, /标识name:红色 /属性名称, id:t2,name:绿色,key:品牌value: id:s1,name:雅培, id:s2,name:雅士利2.5.3 商品详情发送方式发送URL备注GET/product参数名称描述样例pId商品ID1102539服务器返回数据描述样例a 一般情况下无子母码商品，如果有通过用户子母码属性交叉筛选能唯一确认ID。b 商品详情内容较多，所以建议用户点击时单独请求处理c 因子母码交叉属性都会引起商品价格不同，当用户确定属性之后需要实时请求服务器数据进行价格刷新d 当颜色和尺码只有其一时，color_list或size_list信息为全。response: product,product: id: 1102539, /商品IDname: 雅培金装, /商品名称marketPrice: 79, /市场价 price: 78, /会员价 limitPrice: 68, /限时抢购价 leftTime: 3600 /剩余时间，单位为秒 pic: /商品图片url,ur2,score: 4.5, /评分available: yes/no, /是否可售buyLimit:购买上限 /单品购买上限product_property: /子母码选择属性color_list: /其他颜色 color:红色, pId:123121， color:蓝色, pId:123121, size_list: /尺码属性值列表 size:M, /尺码 pId:123121, /商品ID price:45 /蓝色+M号价格 如果是特价则为特价 marketPrice:45 /蓝色+M号市场价格 leftTime:3600 / 限时抢购剩余时间, size:L pId:123121 price:45 /蓝色+L号价格marketPrice:45 /蓝色+L号市场价格leftTime:3600 / 限时抢购剩余时间,product_prom: /相关促销信息展示 促销信息1, 促销信息2,comment_count:23, /商品评论数inventory_area:可发送至, /配货说明bigPic: /商品大图 url1, url2, 2.5.4 商品属性变更发送方式发送URL备注GET/product/zimuma参数名称描述样例pId商品ID1102539color颜色白色服务器返回数据描述样例a 选择颜色的时候返回size_listb 选择尺码只有价格变更 response: product_zimuma, product: productId:1102539,marketPrice: 79, /市场价 price: 78， /会员价leftTime:3600 / 限时抢购剩余时间size_list: /尺码属性值列表 size:M, /尺码 pId:123121, /商品ID price:45 /蓝色+M号价格marketPrice:45 /蓝色+L号市场价格leftTime:3600 / 限时抢购剩余时间, size:L pId:123121, price:45 /蓝色+M号价格marketPrice:45 /蓝色+L号市场价格leftTime:3600 / 限时抢购剩余时间,pic: /商品图片url,ur2,bigPic: /商品图片url,ur2 2.5.5 商品子母码(作废)发送方式发送URL备注GET/product/zimuma参数名称描述样例pId商品ID1102539attribute属性ID+属性值ID12:1202|13:1301服务器返回数据描述样例搜索页面调用获取推荐搜索词搜索历史为本地的缓存 response: product_zimuma, product: productid:1102539,name: 雅培金装, /商品名称marketprice: 79, /市场价 price: 78 /会员价 2.5.6 商品描述发送方式发送URL备注GET/product/description参数名称描述样例pId商品ID1102539服务器返回数据描述样例response: product_description,productdesc: /商品详情描述2.5.7 商品大图(作废)发送方式发送URL备注GET/product/pic参数名称描述样例pId商品ID服务器返回数据描述样例response: product_pic,pic: /商品大图URL列表 url1, url22.5.7 商品评论发送方式发送URL备注GET/product/comment参数名称描述样例pId商品ID1102539page第几页1pageNum每页个数10服务器返回数据描述样例response: product_comment,comment: /评论列表 title:东西不错, /评论标题 content:东西不错, /评论内容 username:用户, /评论用户 time:2001-12-24 23:00:00 /评论时间, title:东西不错, /评论标题 content:东西不错, /评论内容 username:用户, /评论用户 time:2001-12-24 23:00:00 /评论时间,list_count:1500 /评论总数2.5.8 商品收藏发送方式发送URL备注GET/product/collect参数名称描述样例pId商品ID1102539服务器返回数据描述样例response: product_collect2.6 购物车2.6.1 进入购物车发送方式发送URL备注GET/cart参数名称描述样例sku商品ID:数量|商品ID:数量1200001:3|1200004:2服务器返回数据描述样例response: cart,productlist: /商品列表 缺商品数量，小计id:1200001, /商品IDname: 雅培金装, /商品名称pic:, /商品图片URLprice:89, /商品售价“color”:”红色”,“size”:”M” prodNum:3 /商品数量subtotal:290.9 /商品金额小计 number: 0, /商品库存数量，0为缺货或下架 uplimit:10 /商品购买数量上限,id:1200001, /商品IDname: 雅培金装, /商品名称pic:, /商品图片URLprice:89, /商品售价“color”:”红色”,“size”:”M” number: 0, /商品数量，0为缺货或下架 uplimit:10 /商品购买数量上限 isgift:yes /是否赠品,cart_prom: /享受促销信息 促销信息一, 促销信息二,cart_addup: /购物车总计 total_count:3, /商品数量总计 total_price:230, /商品金额总计 total_point:230 /商品积分总计2.6.2 修改数量同上2.6.3 删除商品同上2.7 结算中心2.7.1 结算中心信息发送方式发送URL备注POST/che