[[TOC]] = 聚超值2.1.0接口文档 = == 一.基本约定 == {{{ 1.开发机、测试机代理地址： mrobot开发机代理：192.168.10.199 端口：1080 mrobot测试机代理：192.168.10.198 端口：1080 电脑网应用端测试环境域名 v42.pconline.com.cn 电脑网应用端线上环境域名 best.pconline.com.cn mrobot线上环境域名：mrobot.pconline.com.cn mrobot测试环境域名：v80.pconline.com.cn mrobot开发环境域名：dev40.pconline.com.cn 2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 { "desc":"给用户的提示放在这里" } 4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 7.需要分页的接口，统一返回以下字段: pageNo,pageSize,total 8.接口标题后小括号的字母代表开发的优先级，h——高，m——中，l——低 }}} == 二.接口列表 == == 1 首页模块 == === 1.1 首页精选列表 === '''（mrobot开发完成，请连开发机进行调试）'''[[BR]] **需求：**[[BR]] 1、listIndex数组中的爆料实体，新增showModeForApp字段，经验晒物两种展示方式: 0.小图模式 1.大图模式；[[BR]] 2、返回数据新增置底位爆料lastIndex；[[BR]] **mrobot接口** >http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp [[BR]] >eg: http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp?pageNo=1&pageSize=20&v=2.1.0 [[BR]] **后端接口** >[http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/facade 首页数据接口] eg：http://best.pconline.com.cn/app/facade/cache/index.do?pageNo=1&pageSize=20 [[BR]] >[http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/11_focusImage 焦点图] eg：http://best.pconline.com.cn/app/focus/cache/listFocus.do?topicTypeId=0&type=0&v=2.1.0 [[BR]] >[http://best.pconline.com.cn/app/topic/cache/getTopicListOfFixTail.do?pageNo=1 置底位爆料] eg：http://best.pconline.com.cn/app/topic/cache/getTopicListOfFixTail.do?pageNo=1 【V2.1.0需求】[[BR]] **说明** > 获取推荐首页列表数据 + 焦点图（另外的接口，当pageNo为1时返回）+ 置底爆料[[BR]] **提交方式** > GET[[BR]] **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| ||pageNo||页数||int||1||是|||| ||pageSize||页面大小||int||20||是|||| ||v||版本号||int||0||是||用于控制是否在聚超值后台插入广告，例如2.1.0版本传v=2.1.0|| **返回** {{{#!java { status: 1, msg: "请求成功", pageNo: 1, pageSize: 20, pageTotal: 2168, total: 43357, focus: [//焦点图 {//from $focusImage focusImageId: 12, typeId: 爆料类型Id imageUrl: "http://img.pconline.com.cn/7.jpg", // 焦点图 seq: 1, positionIndex: 1, // 0 app端焦点图、1 wap端焦点图、2 pc端首页焦点图、3 pc端海淘焦点图、4 PC端晒货焦点图、5 PC端经验焦点图、6 WAP端首页焦点图、7 wap端海淘焦点图、8 wap端发现焦点图、9 wap端晒物焦点图、10 wap端经验焦点图 focusTitle: "现货直接买!iPhone6 Plus 64G三网通5K1", // 标题 topicId: 125, // 爆料id sectionType: 1 // 顶级的栏目id：0优惠，1海淘，2 发现，3 晒物，4经验 url: "http://a.c.com/1.do", // pc端焦点图跳转url,ps:该字段有数据时才显示，无数据时不显示 createAt： 136521542140000 // 创建时间 } ... ] listIndex:[//原始列表数据 { type:1 // 1 爆料 value:{//from $topic topicId: 2395585, title: "有钱你就来", //标题 shortTitle: "超值商品推荐" // 短标题 section: 1, // 栏目：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题 topSection: 1 // 顶级的栏目id：0优惠，1海淘，2 发现，3 晒物，4经验 mallName: "京东", // 电商名称 mallId: 1, // 电商id price: "五折对低价199", // 价格描述 pubDate: 13215412512000, // 发布时间,时间戳 毫秒 overdueStatus: 1, // 是否过期 endTime: 13251245121000, // 优惠截止时间 channelId: 12, // 计数器栏目id imagesForList: "http://www.a.b/a.png", hasCoupon: 0, // 是否有优惠券，适用于 优惠，海淘 cover: "http://www.google.com/1.png", hdCover: "http://www.google.com/1_hd.png", // 高清图，适用于晒物，经验，试用体验 showPicForApp: 1, // 是否白菜价合集 showModeForApp: 1 //经验晒物两种展示方式: 0.小图模式 1.大图模式【V2.1.0需求:新增字段】 } } { type:2 // 2 推荐位 value:{//from $adPosition adId: 51, adTitle: "好东西哇", price: "12块包邮", imageUrl: "http://img.pconline.com.cn/7.jp", topicId: 23412 section: 1, // 栏目：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题 topSection: 1 // 顶级的栏目id：0优惠，1海淘，2 发现，3 晒物，4经验 url: "http://g.pconline.com.cn/a/73727.html", // 跳转链接 urlType: 1, // 1 爆料 2 网页, seq:3 // 排序，插入到首页的位置 } } { type:4 // 4 优惠券 value:{//from $gift giftId: 1, // 礼品Id name: "京东卡", needScore: 10, //所需积分 needGold: 2,//所需金币 mallId: 12, // 电商Id mallName: '京东', // 电商名称 imageUrl: "http://a.cn/1.png", // 图片 imgPath260x130："",//260x130图片 discount: "满400减20", // 优惠券额度 createTime: 13251245124000, // 创建时间 expiryDate: 13621321521000, // 有效期 remainingDay:2 // 当前时间距离优惠券过期的天数 } } ... ] lastIndex:[//置底爆料数据【V2.1.0需求】 { type:1 // 1 爆料 value:{//from $topic topicId: 2395585, title: "有钱你就来", //标题 shortTitle: "超值商品推荐" // 短标题 section: 1, // 栏目：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题 topSection: 1 // 顶级的栏目id：0优惠，1海淘，2 发现，3 晒物，4经验 mallName: "京东", // 电商名称 mallId: 1, // 电商id price: "五折对低价199", // 价格描述 pubDate: 13215412512000, // 发布时间,时间戳 毫秒 overdueStatus: 1, // 是否过期 endTime: 13251245121000, // 优惠截止时间 channelId: 12, // 计数器栏目id imagesForList: "http://www.a.b/a.png", hasCoupon: 0, // 是否有优惠券，适用于 优惠，海淘 cover: "http://www.google.com/1.png", hdCover: "http://www.google.com/1_hd.png", // 高清图，适用于晒物，经验，试用体验 showPicForApp: 1 // 是否白菜价合集 showModeForApp: 1 //经验晒物两种展示方式: 0.小图模式 1.大图模式【V2.1.0需求:新增字段】 } } ] } }}} [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#焦点图 $focusImage] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料 $topic] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#推荐位 $adPosition] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼品 $gift] ---------- === 1.2 单篇爆料、晒物、经验、体验报告、专题终端页（Web） === '''（mrobot开发完成，请连开发机进行调试）'''[[BR]] **需求：**[[BR]] 1、附加信息新增commentCount（评论数）和commentId（评论id）；[[BR]] 2、附加信息新增模板版本号，iphoneResVer（iOS）或androidResVer（Android），用于终端页的优化，根据平台返回其中一个[[BR]] 3、爆料详情终端页优化：[[BR]] 为进一步加快爆料详情终端页的传输速度，将终端页拆分成css、js和html主体两个部分，其中css、js放客户端本地，html主体由mrobot接口给出；客户端需支持在线更新css、js功能 [[BR]] 资源更新配置地址：pconline_best_android_auto_update.json、pconline_best_iphone_auto_update.json [[BR]]请求参数：新增如下请求参数 platform //平台标识。android平台，platform=android；iOS平台，platform=iOS[[BR]] v=2.1.0 //版本号[[BR]] resVer //资源包版本号。resVer=21000，此版本号由app版本号和资源包迭代版本构成，如资源包初始版本，resVer=21000；资源包第一个新版本，resVer=21001，如此类推 **原mrobot接口** > http://mrobot.pconline.com.cn/s-1800/best/cms/topicDetail.xsp?topicId=125405 **mrobot接口** > http://mrobot.pconline.com.cn/s-1800/best/cms/topicDetail.xsp?topicId=125405&platform=iOS&v=2.1.0&resVer=21000 **后端接口** > [http://trac.pc.com.cn/pc_best/wiki/app2.0/01_topic#爆料详细信息 爆料详细信息] eg：http://best.pconline.com.cn/app/topic/getTopicInfo.do?topicId=125405&fontSize=17&hd=0 [[BR]] > 评论数接口 eg：http://cmt.pconline.com.cn/action/topic/get_data.jsp?url=http://best.pconline.com.cn/discovery_art.jsp?topicId=125405 **说明** > 单篇爆料或者晒物、经验、体验报告、专题终端页 **提交方式** > GET **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||topicId||爆料id||int||0||是|| ||fontSize||字体大小||int||17||是|| ||hd||是否显示高清图：0 否 1 是||int||0||否|| ||platform||平台标识。android平台，platform=android；iOS平台，platform=iOS||String||""||是|| ||v||版本号||String||"0.0.0"||是|| ||resVer||资源包版本号||int||0||是|| **返回**[[BR]] web页面的html代码，内嵌JSON格式的附加信息，以及点击交互的跳转协议[[BR]] 附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾[[BR]] 附加信息： ||= 爆料类型 =||= 附加信息 =|| ||优惠、海淘、发现||#data1#|| ||晒物、经验||#data2#|| {{{ #data1#包含： { topicId: 13253,//爆料id topicType: 1,//0优惠，1海淘，2 发现 url: http://best.pconline.com.cn/discovery_art.jsp?topicId=$topic.topicId //用于评论数 artUrl:"http://best.pconline.com.cn/youhui/125405.html",//pc地址，用于分享 title: $topic.shortTitle + $topic.price + $topic.sectionDesc wxTitle:【今日聚超值_栏目】+$topic.title||topic.shortTitle+" "+$topic.price（其中栏目为具体的typeName,0,1,2时显示title,3,4时显示为shortTitle）, date: $topic.pubDate author: $topic.createNamePrefix purchasingNum: $topic.purchasingCount.totalCount firstPic: $topic.cover(获取350x350大小的) bestBuyLink:"bestbuy://topic-1.cc", //直达链接，可能是自定义的协议或者普通的url commentCount:245 //评论数 【V2.1.0需求:新增字段，请求评论数接口获取】 commentId:45 //评论id 【V2.1.0需求:新增字段，请求评论数接口获取】 iphoneResVer:21000 //模板版本号（iOS请求时返回）【V2.1.0需求:新增字段，用于终端页的优化】 androidResVer:21000 //模板版本号（Android请求时返回）【V2.1.0需求:新增字段，用于终端页的优化】 } #data2#包含： { topicId: 13253, //爆料id topicType: 3, //3 晒物，4经验 url: http://best.pconline.com.cn/discovery_art.jsp?topicId=$topic.topicId artUrl:"http://best.pconline.com.cn/youhui/125405.html",//pc地址，用于分享 title: $topic.shortTitle + $topic.price + $topic.sectionDesc wxTitle:【今日聚超值_栏目】+$topic.title||topic.shortTitle+" "+$topic.price（其中栏目为具体的typeName,0,1,2时显示title,3,4时显示为shortTitle）, date: $topic.pubDate author: $topic.createNamePrefix purchasingNum: $topic.purchasingCount.totalCount firstPic: $topic.cover,(获取350x350大小的) commentCount:245 //评论数 【V2.1.0需求:新增字段，请求评论数接口获取】 commentId:45 //评论id 【V2.1.0需求:新增字段，请求评论数接口获取】 iphoneResVer:21000 //模板版本号（iOS请求时返回）【V2.1.0需求:新增字段，用于终端页的优化】 androidResVer:21000 //模板版本号（Android请求时返回）【V2.1.0需求:新增字段，用于终端页的优化】 } }}} 跳转协议：[[BR]] 优惠/海淘/发现 详情终端页:[[BR]] 正文字号的问题，跟前端和设计确认了，设计稿的尺寸到制作稿时要减半，所以正文的大中小字号应该分别为19、17、15 ||=协议=||=参数说明=||=触发事件=|| ||pconlinebestbuy://best-coupon-detail/giftId||giftId：优惠券id||点击爆料详情终端页的"优惠券"内时触发，进入优惠券详情|| ||pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex}||topicId：爆料id；curIndex：图片序号||点击爆料详情终端页的任一张图片时触发，浏览大图 || ||pconlinebestbuy://best-shop-list/topicId||topicId：爆料id||点击爆料详情终端页的"有**家商家可代购"时触发，进入商家列表|| ||pconlinebestbuy://best-outer-web/?url={url}||url：代购地址||点击爆料详情终端页底部的"推荐代购商家"时触发，进入商家淘宝商品外链（此处需要计数器，此url尾加对应的类型，计数由app做，url添加尾字符由best提供，代购页面跳转协议中的url后带上#Purchase，商家购买页面跳转协议中的url后带上#GoSeeIt）|| [[BR]] 晒物详情终端页:[[BR]] ||=协议=||=参数说明=||=触发事件=|| ||pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex}||topicId：爆料id；curIndex：图片序号||点击爆料详情终端页的任一张图片时触发，浏览大图 || ||pconlinebestbuy://best-outer-web/?url={url}||url：代购地址||点击爆料详情终端页底部的"推荐代购商家"时触发，进入商家淘宝商品外链|| 经验详情终端页:[[BR]] ||=协议=||=参数说明=||=触发事件=|| ||pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex}||topicId：爆料id；curIndex：图片序号||点击爆料详情终端页的任一张图片时触发，浏览大图 || [[BR]] 晒物及经验详情页面，头图采用hdCover,按hd=0则取hdCover的400x200尺寸,hd=1则取hdCover的600x300尺寸 ---------- == 2 个人中心 == === 2.1 获取用户扩展信息 === （后端测试环境已经修复，请连接测试环境进行验证）[[BR]] **需求：**[[BR]] 1、当前线上接口返回的couponNum字段是所有（可用和过期）优惠券的总数，需修改为只返回“可用”优惠券的数目；[[BR]] **mrobot接口** > http://mrobot.pconline.com.cn/s/best/my/getUserExtend.xsp **后端接口** > [http://trac.pc.com.cn/pc_best/wiki/app2.0/03_personal#获取用户扩展信息 获取用户扩展信息] http://best.pconline.com.cn/app/my/user/getUserExtend.do **说明** > 获取用户扩展信息 **提交方式** > GET **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||common_session_id||-||String||""||是|| **返回** {{{#!java { status: 1, msg: "请求成功", data: {//from $userExtend topicNum: 1,//我的爆料数 favNum: 10,//我的收藏数 couponNum: 2//我的可用优惠券数【V2.1.0需求:字段值修改】 } } }}} [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#用户扩展信息 $userExtend] ---------- === 2.2 推送设置内容定制列表 === '''（mrobot开发完成，请连开发机进行调试）'''[[BR]] **需求：**[[BR]] 1、返回数据data数组中的每一项需返回是否已订阅的状态；[[BR]] **mrobot接口**： > http://mrobot.pconline.com.cn/s/best/cms/listTopicType.xsp **后端接口** > http://best.pconline.com.cn/app/topicType/cache/listIndexTopicType.do?limit=15 > http://best.pconline.com.cn/app/subscription/listSubscription.do?addition=abc **说明** > 推送设置内容定制列表 **提交方式** > GET **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| || addition ||token（需加密）|| String ||""||是|| || device ||设备类型 0 iOS, 1 android|| int ||0||是|| **返回** {{{#!java { status: 1, msg: "请求成功" data:[ {//from $topicType typeId: 1, name: '数码家电', level: 1 // 分类等级, subscribed: 1 // 是否已订阅 1-是 0-否【V2.1.0需求:新增字段】 }, ... ] } }}} [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料类型 $topicType] ---------- == 3 广告接口 == （mrobot已完成开发，请连开发机进行调试）[[BR]] **mrobot接口** > http://mrobot.pconline.com.cn/s/best/ad/ad.xsp **后端接口** > http://ivy.pconline.com.cn/adpuba/show?id={广告标识}&media=js **说明** > 广告接口 **提交方式** > GET **参数** > 无 **返回** {{{ { "pc.khd.best.qdtdh.": {//启动图广告 "rule": { "delay": 0, "interval": 1, "age": 2 }, "ad": { "img": "http://imgad0.pconline.com.cn/ivy/image/20154/2/14279648642540.jpg", "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=362147&id=pc.khd.best.qdtdh.&media=js", "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=362147&id=pc.khd.best.qdtdh.", "vc3d-uri": "", "cc3d-uri": "", "cc-uri": "", "isShowDetail": "0" //是否显示详情按钮，isShowDetail=0时，不显示；isShowDetail=1时，显示 } }, "twlb1":[//精选列表广告 { "id":{广告标识} "seq":5,//插入序号 "type":101,//固定101，用于APP区分数据类型 "value":{ "title": "我在 @今日聚超值 上发现了一个超值的折扣优惠", "img": "http://imgad0.pconline.com.cn/ivy/image/20154/2/14279648642540.jpg", "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=362147&id={广告标识}&media=js", "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=362147&id={广告标识}", "vc3d-uri": "", "cc3d-uri": "", "cc-uri": "" } }, ... ] } }}} ---------- == 4 启动图编辑位 == （mrobot已完成开发，请连开发机进行调试）[[BR]] **需求：**[[BR]] 1、mrobot增加接口：编辑可在聚超值后台配置启动图；[[BR]] **mrobot接口** > http://mrobot.pconline.com.cn/s/best/cms/getStartPic.xsp **后端接口** > http://best.pconline.com.cn/app/facade/cache/getStartPic.do **说明** > 编辑配置的启动图 **提交方式** > GET **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| ||v||版本号||int||0||否||2.1.0版本传v=2.1.0|| ||inReview||审核状态||int||0||否||1-是，0-不是|| **返回** {{{#!java { status: 1, msg: "请求成功" data:{ rule:{ age: 3 // 展示时间 }, ad:{ img:"http://img.pconline.com.cn/xxx.jpg",//图片 to-uri:"",//详情链点 isShowDetail: "0" //是否显示详情按钮，isShowDetail=0时，不显示；isShowDetail=1时，显示 } } } }}} ---------- == 5 iOS 全屏假广告（用于增加idfa之后审核需求） == **mrobot接口** >http://mrobot.pconline.com.cn/configs/pconline_bestbuy_appstorereview_config [[BR]] **说明** > 此配置接口设置了具体某个版本的审核状态，以及返回全屏假广告数据；iOS审核期间，启动后需要展示全屏假广告，上线之后不出现假广告 [[BR]] **缓存时间** >无 **提交方式** > GET **是否登录** > 否 **数据来源** >太平洋网络移动平台后端-mrobot **参数** >无 **返回** {{{#!java { "v": "2.1.0", "inreview": "1", "image": "http://www1.pcauto.com.cn/app/price.jpg", "cc-uri": "http://ivy.pcauto.com.cn/adpuba/click?adid=344241&id=auto.other.tl1.&", "vc-uri": "http://ivy.pcauto.com.cn/adpuba/show?adid=344241&id=auto.other.tl1.&media=html", "to-uri": "http://audia3etron.yuntumingzhi.cn/Index/wap/" } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =|| ||v||当前版本号|| ||inreview ||是否正在审核中，1为审核中，0为上线|| ||image||假广告图片 || ||cc-uri ||点击计数|| ||vc-uri ||曝光计数|| ||to-uri ||点击广告后的跳转链点||