Changes between Version 2 and Version 3 of price_api_2.1.0

Timestamp:

08/18/2015 11:49:21 AM (11 years ago)

Author:

oujianqiang

Comment:

--

price_api_2.1.0

@@ -35 +35 @@
 
 == 二.接口列表 ==
+
+== 1 首页模块 ==
+=== 1.1 首页列表数据接口 === 
+**(接口已完成，请连开发机进行测试)**
+>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=10&v=201
+
+**后端接口**
+
+> [http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/facade 首页数据接口] [http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/11_focusImage 焦点图]
+> http://best.pconline.com.cn/app/facade/cache/index.do?pageNo=1&pageSize=20 [[BR]]
+> http://best.pconline.com.cn/app/focus/cache/listFocus.do?topicTypeId=0&type=0&v=201
+**说明**
+
+> 获取推荐首页列表数据 + 焦点图（另外的接口，当pageNo为1时返回）
+
+**提交方式**
+
+> GET
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||pageNo||页数||int||1||是||
+||pageSize||页面大小||int||10||是||
+||v||版本号||int||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  // 是否白菜价合集
+            }
+        }
+        {
+            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  // 当前时间距离优惠券过期的天数
+               
+            }
+        }
+        ...
+    ]
+}
+}}}
+
+[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已完成，请连开发机进行测试）**
+> http://mrobot.pconline.com.cn/s-1800/best/cms/topicDetail.xsp?topicId=125405
+
+**后端接口**
+
+> [http://trac.pc.com.cn/pc_best/wiki/app2.0/01_topic#爆料详细信息 爆料详细信息]
+> http://best.pconline.com.cn/app/topic/getTopicInfo.do?topicId=125405&fontSize=17&hd=0
+
+**说明**
+
+> 单篇爆料或者晒物、经验、体验报告、专题终端页
+
+**提交方式**
+
+> GET
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||topicId||爆料id||int||0||是||
+||fontSize||字体大小||int||17||是||
+||hd||是否显示高清图：0 否 1 是||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
+  
+}
+
+#data1#包含：
+{
+  topicId: 13253, //爆料id
+  topicType: 3,    //3 晒物，4经验
+  url: http://best.pconline.com.cn/discovery_art.jsp?topicId=$topic.topicId
+  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大小的)
+  
+}
+}}}
+
+跳转协议：[[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 获取用户扩展信息 === 
+**（mrobot已完成，请连开发机进行测试）**[[BR]]
+**mrobot接口**：
+> http://mrobot.pconline.com.cn/s/best/my/getUserExtend.xsp
+
+**后端接口**
+
+> [http://trac.pc.com.cn/pc_best/wiki/app2.0/03_personal#获取用户扩展信息 获取用户扩展信息][[BR]]
+> 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    
+    }
+}
+}}}
+
+[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#用户扩展信息 $userExtend]
+
+----------
+
+=== 2.2 推送设置内容定制列表 === 
+**（mrobot已完成，请连开发机进行测试）**[[BR]]
+**mrobot接口**：
+> http://mrobot.pconline.com.cn/s-1800/best/cms/listTopicType.xsp
+
+**后端接口**
+
+> [http://trac.pc.com.cn/pc_best/wiki/app2.0/01_1_topicType#获取爆料分类 获取爆料分类][[BR]]
+http://best.pconline.com.cn/app/topicType/cache/listTopicType.do
+
+**说明**
+
+> 推送设置内容定制列表
+
+**提交方式**
+
+> GET
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
+||level||1 一级分类 2 二级分类||int||0||否||
+||parentId||上级分类id||int||0||否||
+
+**返回**
+
+{{{#!java
+{
+  status: 1,
+  msg: "请求成功"
+  data: {//from $topicType
+    typeId: 1,
+    name: '数码家电',
+    level: 1  // 分类等级
+  }
+}
+}}}
+
+[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料类型 $topicType]
+
+----------