Table of Contents
- 一.基本约定
- 二.接口列表
- 1 首页模块
- 2 发现模块
- 3 广场模块
- 4 晒物模块
- 5 经验模块
- 6 搜索模块
- 7 个人中心
- 7.1 (h)获取用户资料
- 7.2 (h)获取用户扩展信息
- 7.3 (h)获取新的爆料数、评论数和试用数
- 7.4 (m)获取我的爆料
- 7.5 (m)获取收藏列表
- 7.6 (m)我的试用 (V2.0.0不需提供)
- 7.7 (m)我的优惠券列表
- 7.8 (h)检查签到状态
- 7.9 (m)签到
- 7.10 (l)添加爆料
- 7.11 (l)推送设置内容定制列表
- 7.12 (l)设置分类订阅
- 7.13 (l)获取用户的精准订阅列表 (V2.0.0不需提供)
- 7.14 (l)添加精准订阅 (V2.0.0不需提供)
- 7.15 (l)删除精准订阅 (V2.0.0不需提供)
- 7.16 (l)获取用户各个频道的收藏数量
- 7.17 (l)系统和评论通知数量
- 7.18 (l)获得系统通知
- 7.19 (l)我收到的评论
- 7.20 (l)我发出的评论
- 8 iOS拓展相关
- 9 广告接口
聚超值2.0.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 (h)首页列表数据接口
(接口已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp
eg: http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp?pageNo=1&pageSize=10&v=201
后端接口
首页数据接口 焦点图 http://best.pconline.com.cn/app/facade/cache/index.do?pageNo=1&pageSize=20
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 | 否 |
返回
{
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 // 当前时间距离优惠券过期的天数
}
}
...
]
}
$focusImage $topic $adPosition $gift
1.2 (h)优惠、海淘、发现、晒物、经验、试用体验、专题列表数据接口
(开发已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-300/best/cms/getTopicList.xsp
eg: http://mrobot.pconline.com.cn/s-300/best/cms/getTopicList.xsp?sectionId=0&pageNo=2&pageSize=20
后端接口
栏目爆料列表 http://best.pconline.com.cn/app/topic/cache/getTopicList.do?pageNo=0&pageSize=20§ionId=0
说明
根据传入的栏目id,获取对应的爆料
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| sectionId | 栏目id:0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题 | int | 0 | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
pageTotal: 2168,
total: 43357
data:[
{//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 // 是否白菜价合集
createName: "Jason@qq.com", // 创建者名称
createNamePrefix: "Jason", // 创建者名称,邮箱前缀
}
...
]
}
1.3 (h)获取用户最新动态变化
与 [7.3 (h)获取新的爆料数、评论数和试用数] 共用同一个接口
获取新的爆料数 评论数 系统消息数和试用数
说明
获取用户某个时间之后的新动态变化
1.4 (m)单篇爆料、晒物、经验、体验报告、专题终端页(Web)
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-1800/best/cms/topicDetail.xsp?topicId=125405
后端接口
爆料详细信息 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 | 否 |
返回
web页面的html代码,内嵌JSON格式的附加信息,以及点击交互的跳转协议
附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾
附加信息:
| 爆料类型 | 附加信息 |
|---|---|
| 优惠、海淘、发现 | #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大小的)
}
跳转协议:
优惠/海淘/发现 详情终端页:
正文字号的问题,跟前端和设计确认了,设计稿的尺寸到制作稿时要减半,所以正文的大中小字号应该分别为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?) |
晒物详情终端页:
| 协议 | 参数说明 | 触发事件 |
|---|---|---|
| pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex} | topicId:爆料id;curIndex:图片序号 | 点击爆料详情终端页的任一张图片时触发,浏览大图 |
| pconlinebestbuy://best-outer-web/?url={url} | url:代购地址 | 点击爆料详情终端页底部的"推荐代购商家"时触发,进入商家淘宝商品外链 |
经验详情终端页:
| 协议 | 参数说明 | 触发事件 |
|---|---|---|
| pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex} | topicId:爆料id;curIndex:图片序号 | 点击爆料详情终端页的任一张图片时触发,浏览大图 |
晒物及经验详情页面,头图采用hdCover,按hd=0则取hdCover的400x200尺寸,hd=1则取hdCover的600x300尺寸
1.5 (m)判断用户是否已收藏爆料
(接口已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s/best/my/checkTopicCollectStatus.xsp
eg: http://mrobot.pconline.com.cn/s/best/my/checkTopicCollectStatus.xsp?topicId=17960
后端接口
说明
判断用户是否已收藏爆料
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| topicId | 爆料id | int | 0 | 是 |
返回
{
status: 1,
msg: "请求成功",
hasCollect: 0// 0 表示未收藏 1 表示已收藏
}
1.6 (m)收藏
(后端处理)
正式: http://best.pconline.com.cn/app/my/collect/collectForApp.do?topicId=17960
测试: http://v42.pconline.com.cn/app/my/collect/collectForApp.do?topicId=17960
开发: http://dev34.pconline.com.cn:81/app/my/collect/collectForApp.do?topicId=17960
后端接口
说明
收藏
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| topicId | 爆料id | int | 0 | 是 |
返回
{
status: 1,
msg: "收藏成功"
}
1.7 (m)取消收藏
(后端处理)
正式: http://best.pconline.com.cn/app/my/collect/decollectForApp.do?topicIds=17960
测试: http://v42.pconline.com.cn/app/my/collect/decollectForApp.do?topicIds=17960
开发: http://dev34.pconline.com.cn:81/app/my/collect/decollectForApp.do?topicIds=17960
后端接口
说明
取消收藏
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| topicIds | 爆料id字符串,英文逗号分隔,如:1,2,3 | String | "" | 是 |
返回
{
status: 1,
msg: "取消收藏成功",
data: {
count: 1 // 成功取消的收藏数
}
}
1.8 (m)获取爆料赞和踩的数量
*此处废弃* (mrobot已完成,请连开发机进行测试)
mrobot地址: http://mrobot.pconline.com.cn/s/best/bbs/getTopicLikeAndDislikeCount.xsp
eg: http://mrobot.pconline.com.cn/s/best/bbs/getTopicLikeAndDislikeCount.xsp?topicId=17960
更正:(此接口不走mrobot,如果做中转,只会取mrobot的ip,这对后端业务逻辑通过ip去点赞等功能会有影响,即是通过ip去点赞等)
http://best.pconline.com.cn/app/topic/getTopicLikeAndDislikeCount.do?topicId=17960
后端接口
获取爆料赞和踩的数量
http://best.pconline.com.cn/app/topic/getTopicLikeAndDislikeCount.do?topicId=17960
说明
用于终端页显示爆料的赞和踩的数量
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
goodCount: 12,
badCount: 1,
isVoted: 0
}
}
1.9 (m)赞或者踩
(后端处理)
正式: http://best.pconline.com.cn/app/topic/likeAndDislike.do?topicId=17960&operate=0
测试: http://v42.pconline.com.cn/app/topic/likeAndDislike.do?topicId=17960&operate=0
开发: http://dev34.pconline.com.cn:81/app/topic/likeAndDislike.do?topicId=17960&operate=0
后端接口
说明
对爆料点赞或踩
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
| operate | 操作:0 赞 1 踩 | int | 0 | 是 |
返回
{
status: 1,
msg: "感谢您的投票",
}
1.10 (l)爆料正文中图片集列表
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-1800/best/cms/listTopicImages.xsp?topicId=17960
后端接口
获取爆料正文中的图片集
" http://best.pconline.com.cn/app/topic/cache/listTopicImages.do?topicId=17960
说明
从终端页中获取到所有上传的图片,用于浏览图模式
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
返回
{
"data": [
{
"index": 1,
"url": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1503/10/c3/3690946_1425973613528_width600.jpg"
},
{
"index": 2,
"url": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1503/10/c3/3689531_1425973005147_width600.png"
},
{
"index": 3,
"url": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1503/10/c2/3689523_1425972209066_width600.png"
}
],
"msg": "请求成功",
"status": 1
}
1.11 (l)代购商家列表
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/purchasing/listPurchasing.xsp
后端接口
获取爆料的代购列表
http://best.pconline.com.cn/app/purchasing/cache/listPurchasing.do
说明
获取代购列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
| pageNo | 页数 | int | 1 | 否 |
| pageSize | 页面大小 | int | 10 | 否 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
pageTotal: 5,
total: 100,
data: {//from $purchasing
description: "超值代购", //代购商家描述
hasSpotGoods: 1, // 是否有现货:0 现货/1 代购
link: "http://www.taobao.com/item_1.html" //代购地址
userName: "Jason", //用户名,对应后端参数"name"
nickName: "Jason", //昵称
logo: "http://img.pc.com.cn/1.png", //头像 从平台获取
price: 128, //价格
}
}
1.12 (l)获取求购数
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s/best/purchasing/getTopicBuyCount.xsp
后端接口
获得爆料求购数 http://best.pconline.com.cn/app/purchasing/getTopicBuyCount.do
说明
获得爆料求购数
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
返回
{
"data": {
"count": 0
},
"msg": "请求成功",
"status": 1
}
1.13 (l)求代购规则
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-1800/best/bbs/getTopicBuyRule.xsp
后端接口
求代购规则
http://best.pconline.com.cn/app/purchasing/cache/getCheckinTopicBuyRule.do
说明
求代购规则
提交方式
GET
参数 无
返回
{
status: 1,
msg: "请求成功",
data: {
awardId: 17, 规则id
description: "发布求购扣除钻石", // 规则描述
experience: 0, // 所需经验
gold: 0, // 所需金币
pristige: 0, // 所需威望
purchasingGold: 0, // 所需钻石
score: 0, // 所需积分
totalCount: 0 // 每天限制次数
}
}
1.14 (l)求代购
(后端处理)
正式: http://best.pconline.com.cn/app/my/purchasing/addTopicBuyCount.do
测试 http://v42.pconline.com.cn/app/my/purchasing/addTopicBuyCount.do
开发 http://dev34.pconline.com.cn/app/my/purchasing/addTopicBuyCount.do
后端接口
说明
求代购
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 |
| price | 求购价 | int | 0 | 否 |
| name | 称呼 | String | "" | 是 |
| contactWay | 联系类型 1:手机号码 2:旺旺号码 3:QQ号码 | int | 0 | 是 |
| contactInfo | 联系方式 | String | "" | 是 |
返回
{
status: 1,
msg: "申请成功"
}
1.15 (l)优惠券终端页(Web)
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
说明
优惠券终端页
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| giftId | 礼品id | int | 0 | 是 |
| fontSize | 字体大小 | int | 14 | 是 |
返回
web页面的html代码,内嵌JSON格式的附加信息,以及点击交互的跳转协议
附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾
>>>>>>>>>>附加信息:
{
giftId: 1, // 礼品id
stockNum: 12, // 剩余库存
expiryDate: 13621321521000, // 有效期
remainingDay:2 // 当前时间距离优惠券过期的天数
}
<<<<<<<<<<
1.16 (l)领取优惠券
(后端处理)
正式: http://best.pconline.com.cn/app/my/gift/exchangeCoupon.do
测试: http://v42.pconline.com.cn/app/my/gift/exchangeCoupon.do
开发: http://dev34.pconline.com.cn:81/app/my/gift/exchangeCoupon.do
后端接口
说明
兑换优惠券接口,是否登录,是否已领完,是否已失效,金币,积分是否不足
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| giftId | 礼品Id,注意这里传入礼品的giftId而不是优惠券的couponId | int | 1 | 是 |
返回
{
status: 1,
msg: "兑换成功",
data: {
status:1, // 1 兑换成功 -1 请刷新页面重试 -2 该优惠券无效 -3 该优惠券已过期 -4 兑换出错,请稍后再试。 -5 优惠券领取次数超过限制! -6 金币或积分不足! -7 该优惠券无效或已全部被兑换! -8 兑换失败!
cardNum: 123, //券号
giftStatus: 1,
cardPassword: 123456, //密码
mallUrl: "http://a.b.c", //优惠券所属的电商首页
gold:1, //用户的金币数
score: 2 //用户的积分数
}
}
2 发现模块
2.1 发现列表
http://trac.pc.com.cn/iphone/wiki/price_api#a1.2h优惠海淘发现晒物经验试用体验专题列表数据接口
2.2 发现详情
http://trac.pc.com.cn/iphone/wiki/price_api#a1.4m单篇爆料晒物经验体验报告专题终端页Web
3 广场模块
3.1 (h)广场数据接口
(开发已完成,请连开发机进行测试)
mrobot地址: http://mrobot.pconline.com.cn/s-300/best/cms/sunplaza.xsp
eg: http://mrobot.pconline.com.cn/s-300/best/cms/sunplaza.xsp
后端接口
广场数据接口
http://best.pconline.com.cn/app/facade/cache/sunplaza.do
说明
获取广场首页需要的内容. 其中最新试用是上面这个
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|
返回
{
status: 1,
msg: "请求成功",
data:{
sunplazaEntrys: [//四个自由快捷入口
{//from $sunplazaEntry
type: 1, // 1 标签爆料列表,2 分类爆料列表,3 电商爆料列表,4 爆料终端页,5 专题页,6 试用详情页,7 外链,8 搜索结果页,9商家优惠券列表
tagName: 123, // 标签爆料id int。字段名由mrobot接口根据type类型定义
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{
type: 2, // 2 分类爆料列表
catId: 123, // 分类爆料id int。字段名由mrobot接口根据type类型定义
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{//from $sunplazaEntry
type: 3, // 3 电商爆料列表
mallName: 13, // 电商名称 String,字段名由mrobot接口根据type类型定义
mallType:0 //电商类型 int。
///ps:字段名由mrobot接口根据type类型定义 value:"mallName,mallType" mallName用于search搜索接口查的是mallName,mallType用于显示国内还是国外电商
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{//from $sunplazaEntry
type: 4, // 4 爆料终端页
topicId: 123, // 爆料id int。字段名由mrobot接口根据type类型定义
topSection: 1 // 顶级的栏目id:0优惠,1海淘,2 发现,3 晒物,4经验
///ps:value:topicId,topSection:topicId用于跳转到详情,topSection由于app自身业务需要用到topSection参数,用于各种跳转协议 eg:pconlinebestbuy://best-buy-article/topicId?type={type}
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{//from $sunplazaEntry
type: 5, // 5 专题页
url: "http://www.a.cc/w.do", // 专题页链点。字段名由mrobot接口根据type类型定义
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{//from $sunplazaEntry
type: 7, // 7 外链
url: "http://www.a.cc/w.do", // 外链链点。字段名由mrobot接口根据type类型定义
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
{//from $sunplazaEntry
type: 8, // 8 搜索结果页
keyword: "苹果", // 搜索热词。字段名由mrobot接口根据type类型定义
icon: "http://img.pconline.com.cn/1.png",
name: "白菜价"
},
...
],
hotSpecial: {//热门专题一个 from $special
specialId:1,
title: "双十一精选",
cover: "http://img.pconline.com.cn/1.png",
url: "http://g.pconline.com.cn/link/a.html"
},
activitys: [//热门电商活动四个
{//from $activity
activityId: 1,
cover: "http://1.c.cn/2.png", // app活动封面
title: "亚马逊精选礼品图书满300-100",
url: "http://www.a.cc/w.do", // 链点
urlType: 1 // 爆料终端页 2 外部网页链接
topicId: 123, // 爆料id
sectionId: 1, // 栏目id
sectionType: 1, // 爆料类型
topicTitle: "好东西", // 爆料标题
description: "好活动", // 活动描述
seq: 1, // 排序
isTop: 1, // 是否置顶
isHaiTao: 1, // 是否海淘活动
isMall: 1, // 是否电商活动
createAt: 13251245121000,
},
...
],
gift: { // 热门优惠券一个from $gift
/** couponId: 123, // 优惠券Id 此处去掉,一个giftId可对就多个counponId**/
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 // 当前时间距离优惠券过期的天数
},
//-------2015.3.27决定去掉V2.0.0【试用】相关的功能,故此处不需要返回trail字段
trial:{ //最新试用一个
activityId:12, // 试用活动id
title:"", // 试用活动标题
applyEndAt:13251245124000, // 申请结束时间
type:0, // 活动类型 0海测 1精测
quantity:5, // 产品数量
applyCount:300, // 提交申请的人数
face_1:"", // 390x195封面
face_2:"", // 540x270封面
face_3:"", // 130x130封面
face_4:"" // 140x170封面
},
hotTopics: [ //排行榜五个
{//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 // 是否白菜价合集
},
...
]
}
}
}
$appSunplazaEntry
$special
$gift
$activity
$topic
3.2 (h)获取新试用数 (V2.0.0不需提供)
(mrobot开发已完成,可连开发机进行测试)
http://mrobot.pconline.com.cn/s-2/best/bbs/countActivity.xsp?limit=2&date=1427678976999
后端接口
某个时间后的有效试用条数
http://best.pconline.com.cn/app/service/countActivity.jsp?limit=3&date=134xxx
说明
某个时间后的有效试用条数
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| limit | 限制条数 | int | 1 | 否 |
| date | 时间 | String | 当前时间(毫秒数) | 是 |
返回
{
status: 1,
msg: "请求成功",
limit: 1,
data: 2 // 有效试用个数
}
3.3 (h)专题列表
(开发已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-300/best/cms/getSpecialList.xsp
eg: http://mrobot.pconline.com.cn/s-300/best/cms/getSpecialList.xsp?pageNo=0&pageSize=10&recommendToAppSunplaza=-1
后端接口
说明
分页获取专题列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $special
specialId:1,
title: "双十一精选",
cover: "http://img.pconline.com.cn/1.png",
url: "http://g.pconline.com.cn/link/a.html"
},
...
]
}
3.4 (h)商家活动列表
(开发已完成,请连开发机进行测试)
mrobot地址: http://mrobot.pconline.com.cn/s-300/best/bbs/listActivity.xsp
eg: http://mrobot.pconline.com.cn/s-300/best/bbs/listActivity.xsp?pageNo=1&pageSize=10
后端接口
活动列表
http://best.pconline.com.cn/app/activity/cache/listActivity.do?pageNo=1&pageSize=20&recommendToAppSunplaza=-1
说明
分页获取活动列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 否 |
| pageSize | 页面大小 | int | 10 | 否 |
| isMall | 1表示获取电商活动 | int | 0 | 否 |
| isHaiTao | 1表示获取海淘列表 | int | 0 | 否 |
返回
{
status: 0,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $activity
activityId: 1,
cover: "http://1.c.cn/1.png", // PC活动封面
appCover: "http://1.c.cn/2.png", // app活动封面。该字段后端暂时没设置,故移动客户端也使用cover字段
title: "亚马逊精选礼品图书满300-100",
url: "http://www.a.cc/w.do", // 链点
urlType: 1 // 爆料终端页 2 外部网页链接
sectionId: 1, // 栏目id
sectionType: 1, // 爆料类型
topicId: 123, // 爆料id
seq: 1, // 排序
isTop: 1, // 是否置顶,1 是 0 否
createAt: 13251245121000
},
...
]
}
3.5 (h)优惠券列表
(mrobot已完成,请连开发机进行测试)
后端接口
http://best.pconline.com.cn/app/gift/cache/listGift.do
说明
分页获取礼品列表,传入type为礼品的类型进行查找
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| type | 礼品类型: 1 礼品卡 2 实物礼品 3 优惠券 | int | 1 | 否 |
| mallId | 电商id,0表示查找所有 | int | 0 | 否 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $gift
couponId: 123, // 优惠券Id
giftId: 1, // 礼品Id
giftName: "京东卡",
needScore: 10, //所需积分
needGold: 2,//所需金币
mallId: 12, // 电商Id
mallName: '京东', // 电商名称
imageUrl: "http://a.cn/1.png", // 图片
createTime: 13251245124000, // 创建时间
disCount: "满400减20", // 优惠券额度
expiryDate: 13621321521000, // 有效期
remainingDay:2 // 当前时间距离优惠券过期的天数
expiry: 1 // 是否有效 true 有效 false 过期
},
...
]
}
3.6 (h)获取用户金币和积分
http://trac.pc.com.cn/iphone/wiki/price_api#a7.1h获取用户资料
3.7 (h)优惠券种类筛选页
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s-1800/best/mall/listMallWithCouponCount.xsp
后端接口
http://best.pconline.com.cn/app/mall/cache/listMallWithCouponCount.do
说明
获取电商列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| type | 礼品类型:1 礼品卡 2 实物 3 优惠券 | int | 3 | 是 |
返回
{
"data": [
{
"count": 0,//单个电商的优惠券数量
"mall": {
"areaType": 0, // 地域类型 0其他电商 1美淘电商 2日淘电商
"imageUrl": "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1502/04/c1/2720379_1423017524135.png",
"mallId": 1,
"name": "京东",//电商名称
"seq": 1,// 排序
"typeId": 0,// 国内外电商 0国内电商 1国外电商
"url": "http://www.jingdong.com"// 电商URL
}
},
......
],
"msg": "请求成功",
"status": 1,
"totalCount": 0//所有电商的优惠券数量
}
3.8 (h)获取试用列表 (V2.0.0不需提供)
mrobot接口:
接口名:
listActivityList
后端接口
说明
根据分类获取试用列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| activityTypeId | 试用类型id,0表示全部 | int | 0 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
trialType: 2,
data: [
{
activityId: "试用活动id",
title: "试用活动标题",
applyEndAt: "申请结束时间",
type: "活动类型 0海测 1精测",
quantity: "产品数量",
applyCount: "提交申请的人数",
face_1: "390x195封面",
face_2: "540x270封面",
face_3: "130x130封面",
face_4: "140x170封面"
}
]
}
3.9 (h)获取试用类型列表 (V2.0.0不需提供)
mrobot接口:
接口名:
listActivityTypeList
后端接口
说明
获取试用类型列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|
返回
{
status: 1,
msg: "请求成功",
data: [
{
activityTypeId: "类别ID",
parentId: "父类别ID",
name: "类别名称"
}
]
}
3.10 (m)试用详情终端页(Web) (V2.0.0不需提供)
mrobot接口:
接口名:
trialActivityDetail
后端接口
说明
试用详情终端页
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| activityId | 试用id | int | 0 | 是 |
| fontSize | 字体大小 | int | 14 | 是 |
返回
web页面的html代码,内嵌JSON格式的附加信息,以及点击交互的跳转协议
附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾
>>>>>>>>>>附加信息:
{
(暂无)
}
<<<<<<<<<<
>>>>>>>>>>跳转协议:
---跳转进入试用申请页 点击试用详情终端页的"申请使用"按钮时触发
pconlinebestbuy://best-trial-apply/activityId
跳转参数说明:
activityId:试用id
<<<<<<<<<<
3.11 (m)判断用户是否已申请 (V2.0.0不需提供)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/checkTopicCollectStatus.xsp?topicId=17960
接口名:
hasApplyForActivity
后端接口
说明
判断用户是否已经申请
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| activityId | 试用id | int | 0 | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
hasApply: 1
}
}
3.12 (l)申请试用 (V2.0.0不需提供)
mrobot接口:
接口名:
createApply
后端接口
说明
申请试用,需填写姓名(最多输入待定个字符)、手机号码(需为1开头的11位数字)、寄送地址(最多输入待定个字符)、QQ号码(需为5~11位数字)、申请理由(至少输入20个汉字)。申请按钮固定在屏幕底部,不随页面滚动。点击”提交申请“,若各输入项均符合规则,则提示申请已受理并返回试用详情页。点击”提交申请“,若某个输入项不符合规则,则页面显示相应提示。
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| activityId | 试用id | long | 0 | 是 |
| name | 姓名 | String | "" | 是 |
| telNum | 手机号码 | String | "" | 是 |
| address | 寄送地址 | long | 0 | 是 |
| qq号码 | int | 0 | 是 | |
| reason | 申请理由 | String | 0 | 是 |
返回
{
status: 1,
msg: "申请成功",
}
4 晒物模块
4.1 晒物列表
http://trac.pc.com.cn/iphone/wiki/price_api#a1.2h优惠海淘发现晒物经验试用体验专题列表数据接口
4.2 晒物详情
http://trac.pc.com.cn/iphone/wiki/price_api#a1.4m单篇爆料晒物经验体验报告专题终端页Web
5 经验模块
5.1 经验列表
http://trac.pc.com.cn/iphone/wiki/price_api#a1.2h优惠海淘发现晒物经验试用体验专题列表数据接口
5.2 经验详情
http://trac.pc.com.cn/iphone/wiki/price_api#a1.4m单篇爆料晒物经验体验报告专题终端页Web
6 搜索模块
6.1 (h)搜索热词和筛选分类
(mrobot已完成,请连开发机进行测试)
mrobot地址: http://mrobot.pconline.com.cn/s-1800/best/search/listTopicHotTagsAndTypes.xsp
后端接口
http://trac.pc.com.cn/pc_best/wiki/app2.0/01_1_topicType#获取爆料分类
http://best.pconline.com.cn/app/topicType/cache/listIndexTopicType.do?limit=15
http://best.pconline.com.cn/app/topicTag/cache/listTag.do?isHot=1&isSpecial=-1&type=0&pageNo=1&pageSize=5
说明
获取热门标签和筛选分类 使用场景:搜索初始界面
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| limit | 显示条数 | int | 15(当与应用接口默认值不一致时,需mrobot设置) | 否 |
| isHot | 是否热点标签 0 否 1 是 -1 所有 | int | 1(当与应用接口默认值不一致时,需mrobot设置) | 否 |
| isSpecial | 是否特色标签 0 否 1 是 -1 所有 | int | -1 | 否 |
| type | 类型 0 聚超值 1 母婴生活馆 -1 所有 | int | 0(当与应用接口默认值不一致时,需mrobot设置) | 否 |
返回
{
status: 1,
msg: "请求成功",
data: {
hotTags: [
{
tagId: 1, // 标签Id
name: "白菜价", // 标签名称
isHot: 1, // 是否热门标签
isSpecial: 1, // 是否特色标签
isRed:1, // 是否套红
description: "最低白菜价", // 标签描述
type: 1 // 0 聚超值 1 母婴生活馆
},
...
]
topicTypes: [
{//from $topicType
typeId: 1,
name: "数码家电",
level: 1,
iconImg2: 'http://best.pconline.com.cn/1.png' // 分类图标
},
...
]
}
}
6.2 (m)搜索接口
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s-300/best/search/listTopicSearch.xsp
后端接口
搜索接口
http://best.pconline.com.cn/app/search/listTopicSearch.do
说明
分类搜索返回5个栏目筛选项 国内电商返回 优惠/发现;国外电商返回 海淘/发现 标签搜索返回5个栏目筛选项 关键词搜索返回关键词 + 5个栏目
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| searchType | 1 按分类搜索 2 按电商搜索 3 按标签搜索 4 按关键词搜索 | int | 4 | 否 |
| searchCondition | 根据searchType传入具体的内容,分类、电商、标签传入对应的id,关键词直接传入搜索的关键词字符串 | 根据searchType而定:1,对应int, 2(电商名称),3(标签名称),4(关键词)对应String | "" | 否 |
| sectionId | 搜索栏目:0 优惠 1 海淘 2 发现 3 晒物 4 经验 | int | 不同类型的搜索出不同的默认值(依据app默认显示的栏目) | 否 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: {
topics: [
{//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 // 是否白菜价合集
createName: "Jason@qq.com", // 创建者名称
createNamePrefix: "Jason", // 创建者名称,邮箱前缀
},
...
],
searchSectionResults: [
{// from $sectionExtend
value: 1,
name: '海淘',
count: 12
},
...
]
}
}
6.3 (h)搜索页电商列表
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-1800/best/search/listMalls.xsp
后端接口
获取电商列表
http://best.pconline.com.cn/app/mall/cache/listMall.do
说明
获取电商列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|
返回
{
status: 1,
msg: "请求成功",
data: [
{//from $mall
mallId: 1,
name: "京东",
url: "http://www.jd.com", // 电商URL
seq: 12, // 排序
typeId: 1, // 国内外电商 0国内电商 1国外电商
areaType: 1, // 地域类型 0其他电商 1美淘电商 2日淘电商
imageUrl: "http://img.pc.com.cn/1.png"
},
...
]
}
6.4 (l)搜索推荐
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s-1800/best/search/searchKeywordHint.xsp?input=fff
后端接口
搜索推荐
http://best.pconline.com.cn/app/search/searchKeywordHint.do?input=
说明
根据搜索输入推荐的热门搜索词
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| input | 输入内容 | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
data: [
{
count: "556",
key: "iphone 5s"
},
...
]
}
7 个人中心
7.1 (h)获取用户资料
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
说明
获取用户资料
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
data: {//from $user
userId: 12,
name: "Jason", // 用户名
nickName: "Jason", // 昵称
email: "Jason@gg.cc", // 电子邮件
face: "http://img.a.b/1.png", // 头像
goldAmount:12, // 金币
score: 10, // 积分
levelId: 12, // 等级Id
experience: 12, // 经验
createAt:135212544845000, // 创建时间
pristige: 10, // 威望值
isBlack: 1, // 是否黑名单
purchasingGold:10, // 钻石
isPurchasing: 1, // 1:代购商家 0:求购买家
}
}
7.2 (h)获取用户扩展信息
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
获取用户扩展信息
http://best.pconline.com.cn/app/my/user/getUserExtend.do
说明
获取用户扩展信息
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
data:
{//from $userExtend
topicNum: 1,
favNum: 10,
couponNum: 2
}
}
7.3 (h)获取新的爆料数、评论数和试用数
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/checkNewsPersonal.xsp
后端接口
http://best.pconline.com.cn/app/my/getNewCountForApp.do
说明
判断是否有新的爆料或者试用
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| lastAccessTime | 最近一次访问该接口的时间 | long(时间戳 毫秒) | 当前时间 | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
newTopicCount: 100,
newCommentCount: 1,
newSystemNoticeCount: 1,
newTrialPassCount: 2,//(V2.0.0不需提供)
newTrialNotPassCount: 2//(V2.0.0不需提供)
}
}
7.4 (m)获取我的爆料
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
说明
用于网友个人中心获取网友的爆料列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| status | 爆料审核状态:1 审核通过 2 审核未通过或者待审 | int | 1 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $topic
topicId: 2395585,
title: "有钱你就来", //标题
shortTitle: "超值商品推荐" // 短标题
goldAmount:10 //// 爆料者获得的金币
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 // 是否白菜价合集
createName: "Jason@qq.com", // 创建者名称
createNamePrefix: "Jason", // 创建者名称,邮箱前缀
reason: "" // 理由,会根据auditStatus出不同文本信息。
auditStatus: 1 // 审核状态。 "0待审", "1已审", "2禁用", "3审核不通过", "4正在处理", "5兼职待审", "6需修改"
}
...
]
}
7.5 (m)获取收藏列表
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
说明
用于网友个人中心获取收藏列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| index | 0 优惠 1 海淘 2 发现 3 晒物 4 经验 | int | 0 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $favorite
favoriteId: 123, // 收藏id
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 // 是否白菜价合集,
createName: "Jason@qq.com", // 创建者名称
createNamePrefix: "Jason", // 创建者名称,邮箱前缀
userId: 12, // 收藏的用户Id
createAt: 13625123531000
}
]
}
7.6 (m)我的试用 (V2.0.0不需提供)
mrobot接口:
接口名:
listMyApplys
后端接口
说明
用于网友个人中心获取到已通过,申请中,未通过3中类型的使用申请
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| status | 0 申请中 -1未通过 1通过 | int | 2 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{
applyId: "试用申请id",
activityId: "试用活动id",
title: "试用活动标题",
status: "试用申请状态",
createAt: "试用申请时间",
face_1: "390x195封面",
face_2: "540x270封面",
face_3: "130x130封面",
face_4: "140x170封面"
}
]
}
7.7 (m)我的优惠券列表
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s/best/my/listMyGiftExchange.xsp
后端接口
说明
用于网友个人中心获取我的礼品列表,type=3的时候表示优惠券,包括未失效和已失效的
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
| status | 状态:1 未过期,2 未过期 | int | 0 | 是 |
| type | 1 礼品卡 2 实物礼品 3 优惠券 | int | 3 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $gift
gift: $gift,
couponId: 123, // 优惠券Id
giftId: 123, // 礼品Id
cardNum: '1232',
cardPassword: 's123sdssdfs54212',
status: 1, // 状态0:禁用;1:未领取;2:已领取
createAt: 1352125412000, // 创建时间
createrId: 132, // 创建人id
updateAt: 13215478541000, // 更新时间
updaterId: 132,
updateName: "Jason", // 更新人
createName: "Jason", // 创建人
useDate: 13212457451000, // 被领取时间
}
]
}
7.8 (h)检查签到状态
(mrobot已完成,请连开发机进行测试)
http://mrobot.pconline.com.cn/s/best/my/checkSignInStatus.xsp
后端接口
说明
检查签到状态
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
signInStatus: 1,
days: 12
}
}
7.9 (m)签到
(后端处理)
正式: http://best.pconline.com.cn/app/my/signIn/signInForApp.do
测试: http://v42.pconline.com.cn/app/my/signIn/signInForApp.do
开发: http://dev34.pconline.com.cn:81/app/my/signIn/signInForApp.do
后端接口
说明
app端签到
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
signInStatus: 1,
addInt: 10,
addCoin: 12,
point: 10,
gold: 10,
addPurchasingGold: 10,
day: 1
}
}
7.10 (l)添加爆料
(后端处理)
正式: http://best.pconline.com.cn/app/topic/addTopic.do
测试: http://v42.pconline.com.cn/app/topic/addTopic.do
开发: http://dev34.pconline.com.cn:81/app/topic/addTopic.do
后端接口
说明
用于网友个人中心增加爆料功能
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| 电子邮件 | String | "" | 如果common_session_id为空,则必须输入email | |
| fromUrl | 来源 | String | "" | 是 |
| content | 用户推荐理由 | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功"
}
7.11 (l)推送设置内容定制列表
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s-1800/best/cms/listTopicType.xsp
后端接口
http://best.pconline.com.cn/app/topicType/cache/listTopicType.do
说明
推送设置内容定制列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| level | 1 一级分类 2 二级分类 | int | 0 | 否 |
| parentId | 上级分类id | int | 0 | 否 |
返回
{
status: 1,
msg: "请求成功"
data:[
{//from $topicType
typeId: 1,
name: '数码家电',
level: 1 // 分类等级
},
...
]
}
7.12 (l)设置分类订阅
(后端处理)
正式: http://best.pconline.com.cn/app/subscription/addSubscription.do
测试: http://v42.pconline.com.cn/app/subscription/addSubscription.do
开发: http://dev34.pconline.com.cn:81/app/subscription/addSubscription.do
后端接口
说明
设置分类订阅
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| addition | 加密后的token | String | "" | 是 |
| ids | 推送分类id | String | "" | 如果common_session_id为空,则必须输入email |
| open | 是否开启推送: 0 不发送 1 发送 | int | 1 | 否 |
| device | 设备类型 0 ios 1 android | int | 0 | 是 |
返回
{
status: 1,
msg: "设置成功"
}
7.13 (l)获取用户的精准订阅列表 (V2.0.0不需提供)
mrobot接口:
后端接口
用户的精准订阅列表
http://best.pconline.com.cn/app/subscription/listSubscriptionSecond.do?pageNo=1&pageSize=20&token=^&HHI
说明
获取用户的精准订阅列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 否 |
| pageSize | 页面大小 | int | 20 | 否 |
| token | 设备id,未加密 | string | "" | 否 |
返回
{
status: 1,
msg: "请求成功"
pageNo: 1,
pageSize: 20,
pageTotal: 2,
total:40
data: {//from $subscriptionSecond
subscriptionId: 1,
keywordId:12,
keyword: "ipad"
}
...
}
7.14 (l)添加精准订阅 (V2.0.0不需提供)
mrobot接口:
接口名:
add_subscription_second
后端接口
说明
设置分类订阅
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| addition | 加密后的token | String | "" | 是 |
| keyword | 关键词 | String | "" | 是 |
| open | 是否开启推送: 0 不发送 1 发送 | int | 1 | 否 |
| device | 设备类型 0 ios 1 android | int | 0 | 是 |
返回
{
status: 1,
msg: "订阅成功"
}
7.15 (l)删除精准订阅 (V2.0.0不需提供)
mrobot接口:
接口名:
del_subscription_second
后端接口
说明
删除精准订阅
提交方式
POST
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| addition | 加密后的token | String | "" | 是 |
| subscriptionId | 关键词订阅id | int | 0 | 是 |
返回
{
status: 1,
msg: "删除成功"
}
7.16 (l)获取用户各个频道的收藏数量
(mrobot已完成,请连开发机进行测试)
后端接口
说明
获取收藏列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "订阅成功",
data: [
{//from $sectionExtend
value: 1,
name: '海淘',
count: 12
},
…
]
}
7.17 (l)系统和评论通知数量
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/getSysNoticeAndCommentNum.xsp
后端接口
http://best.pconline.com.cn/app/my/systemNotice/getSysNoticeAndCommentNum.do
说明
获得系统通知数量和评论数量
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
返回
{
status: 1,
msg: "请求成功",
data: {
sentCount: 1,
receiveCount: 2,
sysMsgCount: 3
}
}
7.18 (l)获得系统通知
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/listSystemNotice.xsp
后端接口
http://best.pconline.com.cn/app/my/systemNotice/listSystemNotice.do
说明
获得系统通知
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageTotal: 15,
pageNo: 1,
pageSize: 10,
total: 2,
data: [
{
accountId: 28467067,
content: "对您的爆料《罗技 UE4000 游戏耳机 试用报告》的反馈:部分图片可以使用800px宽,可能会稍微好点",
createTime: 1411615093000,
groupSend: 0,
groupType: 0,
id: 97207866,
resultText: "",
senderId: 0,
siteId: 1,
status: 1,
type: {
description: "今日最超值",
groupType: 0,
id: 1006,
name: "今日最超值",
siteId: 1,
templateId: 1006
},
typeId: 1006
}
]
}
7.19 (l)我收到的评论
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/listMyReceiveComment.xsp
后端接口
http://best.pconline.com.cn/app/my/comment/listMyReceiveComment.do
说明
获得系统通知
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 10,
total: 20,
pageTotal: 2,
data: [
{//from $receiveComment
commentId: 37283120,
currentFloor: 2,
createAt: 1362154214000,
isSupportPurchasing: 0,
topicId: 80671,
topicLogo: "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1410/28/c0/40244951_1414478236223_150x150.jpg",
topicTitle: "双11预售:佳能 单反相机 1200D/18-55 套机",
topicType: 0, // 0发现,1优惠,2海淘,3晒物,4经验
topicURLForPCWeb: "http://best.pconline.com.cn/faxian_80671.html",
// topicUrl: "http://best.pconline.com.cn/discovery_art.jsp?topicId=80671",该字段与topicURLForPCWeb是一致,帮不再提供topicUrl
urlForComment: "http://best.pconline.com.cn/discovery_art.jsp?topicId=80671",
senderId: 1, // 评论者ID,匿名回复则为0
senderFace: "http://i1.3conline.com/images/upload/upc/face/28/46/70/67/28467067_100x100", // 发送者的头像
senderNickName: "qz31244533", // 发送者的昵称
sendCommentContent: "怎么还要定金的呢", // 发送的评论
userFace: "http://i1.3conline.com/images/upload/upc/face/31/24/45/33/31244533_100x100", // 被回复的头像
userName: "arthinking", // 被回复的昵称
replyRefContent: ""看起来不错哦"", // 被回复的内容
}
]
}
7.20 (l)我发出的评论
(mrobot已完成,请连开发机进行测试)
mrobot接口:
http://mrobot.pconline.com.cn/s/best/my/listMySendComment.xsp
后端接口
http://best.pconline.com.cn/app/my/comment/listMySendComment.do
说明
获得用户发出的评论列表
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| common_session_id | - | String | "" | 是 |
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 10,
total: 20,
pageTotal: 2,
data: [
{//from $sendComment
commentId: 37283120,
currentFloor: 2,
createAt: 1362123452000,
isSupportPurchasing: 0,
textCommentContent: "怎么还要定金的呢",
topicId: 80671,
topicLogo: "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1410/28/c0/40244951_1414478236223_150x150.jpg",
topicTitle: "双11预售:佳能 单反相机 1200D/18-55 套机",
topicType: 0, // 0发现,1优惠,2海淘,3晒物,4经验
topicURLForPCWeb: "http://best.pconline.com.cn/faxian_80671.html",
// topicUrl: "http://best.pconline.com.cn/discovery_art.jsp?topicId=80671",该字段与topicURLForPCWeb是一致
urlForComment: "http://best.pconline.com.cn/discovery_art.jsp?topicId=80671",
senderNickName: "qz31244533", // 发表评论者昵称
senderFace: "http://i1.3conline.com/images/upload/upc/face/28/46/70/67/28467067_100x100" // 发表评论者头像
}
]
}
8 iOS拓展相关
8.1 (l)最新爆料
(mrobot已完成,请连开发机进行测试)
mrobot接口:
后端接口
获取首页最新爆料
http://best.pconline.com.cn/app/topic/cache/getNotificationBarInfo.do
说明
用于iPhone端通知栏
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| limit | 限制条数 | int | 5 | 是 |
返回
{
status: 1,
msg: "请求成功",
data: [
{//from $topic
topicId: 2395585,
title: "有钱你就来", //标题
topSection: 1 // 顶级的栏目id:0优惠,1海淘,2 发现,3 晒物,4经验
price: "五折对低价199", // 价格描述
cover: "http://www.google.com/1.png",
}
...
]
}
9 广告接口
mrobot接口(t已完成,请连开发机进行测试):
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)