![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif){kind=logo}
| Version 37 (modified by chenziyang, 10 years ago) (diff) |
|---|
Table of Contents
聚超值2.3.0接口文档
一.基本约定
1.开发机、测试机代理地址：
mrobot开发机代理：192.168.10.199 端口：1080
mrobot测试机代理：192.168.10.198 端口：1080
电脑网应用端测试环境域名 v72.pconline.com.cn:80
电脑网应用端线上环境域名 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.wap页的附加信息（JSON格式），用注释的方式放到html代码里，以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾
9.接口名称以（M）结尾的代表接口经mrobot转发
二.接口列表
1 功能相关
1.1 首页精选列表数据接口（M）
（未完成）
需求：
请求参数变动：新增3个参数 （无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”； 2）v：app版本号，如2.3.0； 3）inReview=1（Android端不传）； 返回参数变动： 如果是来自iOS的请求，则在Topic类型的实体，新增5个字段： 1、爆料简介synopsis；（不带图片，不带html标签，字数较多[标准由产品定]则截取）； 2、【去看看】链接bestBuyLink； 3、用于分享的链点artUrl； 4、用于分享的标题wxTitle； 5、用于分享的图片firstPic；
mrobot接口
http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp
后端接口
首页精选数据接口： 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=2.3.0&platform=ios&inReview=0
后端接口文档
说明
获取推荐首页列表数据 + 焦点图（另外的接口，当pageNo为1时返回）
缓存时间
300s
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
json
返回
{
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, // 创建时间
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.0新增
}
...
]
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, // 是否白菜价合集
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购
bestBuyLink: "http://item.yhd.com/item/50997527?tracker_u=105608137586", //【去看看】链接 2.3.0新增
artUrl: "http://best.pconline.com.cn/haitao/178445.html", //用于分享的链点 2.3.0新增
synopsis: "买买买买买买买买买买买买买买买买买买...", //爆料简介 2.3.0新增
wxTitle: "【聚超值_优惠】飞利浦无线蓝牙音箱 118元包邮", //用于分享的标题 2.3.0新增
firstPic: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/15/c0/spcgroup/qua_30/16475689_1450145374855_350x350.jpg", //用于分享的图片 2.3.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 // 当前时间距离优惠券过期的天数
}
}
...
]
}
$focusImage $topic $adPosition $gift
1.2 优惠、海淘、发现、晒物、经验列表数据接口（M）
（mrobot已完成开发，请连开发环境进行调试）
需求：
请求参数变动： 1、sectionId参数新增1个取值： 1）sectionId=100[后端已支持]时，请求属于“一键购”的海淘列表数据。 2、新增3个用于控制的参数（无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”； 2）v：app版本号，如2.3.0； 3）inReview=1（Android端不传）； 返回参数变动：新增7个参数 1、新增一键购开关控制字段，用于控制【一键购】列表顶部的文案是否显示； 2、如果是来自iOS的请求，则在Topic类型的实体，新增5个字段： 1）爆料简介synopsis；（不带图片，不带html标签，字数较多[标准由产品定]则截取）； 2）【去看看】链接bestBuyLink； 3）用于分享的链点artUrl； 4）用于分享的标题wxTitle； 5）用于分享的图片firstPic；
mrobot接口
http://mrobot.pconline.com.cn/s-300/best/cms/getTopicList.xsp
后端接口
eg： http://best.pconline.com.cn/app/topic/cache/getTopicList.do?pageNo=0&pageSize=20§ionId=0
后端接口文档
说明
根据传入的栏目id，获取对应的爆料列表
缓存时间
300s
提交方式
GET
是否需要登录
否
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| sectionId | 栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 100 支持官方代购爆料（2.3.0新增） | int | 0 | 是 | |
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
json
返回数据
{
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", // 创建者名称，邮箱前缀
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.0新增
bestBuyLink: "http://item.yhd.com/item/50997527?tracker_u=105608137586", //【去看看】链接 2.3.0新增
artUrl: "http://best.pconline.com.cn/haitao/178445.html", //用于分享的链点 2.3.0新增
synopsis: "买买买买买买买买买买买买买买买买买买...", //爆料简介 2.3.0新增
wxTitle: "【聚超值_优惠】飞利浦无线蓝牙音箱 118元包邮", //用于分享的标题 2.3.0新增
firstPic: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/15/c0/spcgroup/qua_30/16475689_1450145374855_350x350.jpg", //用于分享的图片 2.3.0新增
}
...
]
}
1.3 发现列表的筛选条件（M）
（mrobot已完成开发，请连开发环境进行调试）
需求：
新接口 返回数据顺序为：电商商城（商城），当前热点（标签），精彩推荐（分类）
mrobot接口
后端接口
http://best.pconline.com.cn/app/topic/faxian/cache/screen.do
后端接口文档
说明
返回用于发现类爆料的筛选条件
缓存时间
无
提交方式
GET
是否需要登录
否
参数（待定）
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| type | 获取数据类别 0全部 1电商 2标签 | int | 0 | 否 | |
| v | 版本号 | int | 0 | 否 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
json
返回数据
{
status: 1,
msg: "请求成功",
data:[
{//from $mall
title: "电商商城", //筛选条件名称
type: 1, // 根据type判断这里是什么类型 1 电商 2 标签 3 分类
screens: [
{
id: 1,
name: "京东",
},
...
]
}
{//from $tag
title: "当前热点", //筛选条件名称
type: 2, // 根据type判断这里是什么类型 1 电商 2 标签 3 分类
screens: [
{
id: 1,
name: "精选"
},
...
]
}
{//from $topicType
title: "精彩推荐", //筛选条件名称
type: 3, // 根据type判断这里是什么类型 1 电商 2 标签 3 分类
screens: [
{
id: 1,
name: "数码家电"
},
...
]
}
]
}
$topicFaxianScreenVo
$mall
$tag
$topicType
1.4 发现列表（M）
（未完成）
需求：
新接口
mrobot接口
（待补充）
eg： http://mrobot.pconline.com.cn/xxx（待补充）
后端接口
http://best.pconline.com.cn/app/topic/faxian/cache/getTopicList.do
后端接口文档
说明
获取符合筛选条件的发现列表数据
缓存时间
300s
提交方式
GET
是否需要登录
否
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| sectionId | 栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 | int | 0 | 是 | |
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| mallId | 电商id | int | 0 | 否 | |
| tagId | 标签id | int | 0 | 否 | |
| typeId | 类别id | int | 0 | 否 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
mallId 电商id int 0 否 tagId 标签id int 0 否 typeId 类别id int 0 否
返回格式
json
返回数据
{
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", // 创建者名称，邮箱前缀
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.0新增
bestBuyLink: "http://item.yhd.com/item/50997527?tracker_u=105608137586", //【去看看】链接 2.3.0新增
artUrl: "http://best.pconline.com.cn/haitao/178445.html", //用于分享的链点 2.3.0新增
synopsis: "买买买买买买买买买买买买买买买买买买...", //爆料简介 2.3.0新增
wxTitle: "【聚超值_优惠】飞利浦无线蓝牙音箱 118元包邮", //用于分享的标题 2.3.0新增
firstPic: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/15/c0/spcgroup/qua_30/16475689_1450145374855_350x350.jpg", //用于分享的图片 2.3.0新增
}
...
]
}
1.5 搜索接口（M）
（未完成）
需求：
请求参数变动：新增3个参数 （无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”； 2）v：app版本号，如2.3.0； 3）inReview=1（Android端不传）； 返回参数变动： 如果是来自iOS的请求，则在Topic类型的实体，新增5个字段： 1、爆料简介synopsis；（不带图片，不带html标签，字数较多[标准由产品定]则截取）； 2、【去看看】链接bestBuyLink； 3、用于分享的链点artUrl； 4、用于分享的标题wxTitle； 5、用于分享的图片firstPic；
mrobot接口：
http://mrobot.pconline.com.cn/s-300/best/search/listTopicSearch.xsp
后端接口
后端接口文档
说明
分类搜索返回5个栏目筛选项 国内电商返回 优惠/发现；国外电商返回 海淘/发现 标签搜索返回5个栏目筛选项 关键词搜索返回关键词 + 5个栏目
缓存时间
300s
提交方式
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默认显示的栏目） | 否 |
返回格式
json
返回
{
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", // 创建者名称，邮箱前缀
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.0新增
bestBuyLink: "http://item.yhd.com/item/50997527?tracker_u=105608137586", //【去看看】链接 2.3.0新增
artUrl: "http://best.pconline.com.cn/haitao/178445.html", //用于分享的链点 2.3.0新增
synopsis: "买买买买买买买买买买买买买买买买买买...", //爆料简介 2.3.0新增
wxTitle: "【聚超值_优惠】飞利浦无线蓝牙音箱 118元包邮", //用于分享的标题 2.3.0新增
firstPic: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/15/c0/spcgroup/qua_30/16475689_1450145374855_350x350.jpg", //用于分享的图片 2.3.0新增
},
...
],
searchSectionResults: [
{// from $sectionExtend
value: 1,
name: '海淘',
count: 12
},
...
]
}
}
1.6 爆料详情wap页（M）
（未完成）
需求：
返回数据变动： 1、【优惠】、【海淘】2类的爆料终端页正文内容： 1）新增“可能喜欢”的爆料入口，并加上跳转协议（跳至 爆料终端）； 2）新增“内容标签”，加上点击协议（查看 搜索结果）； 3）新增该爆料相关的优惠页面入口按钮，加上点击协议（查看 爆料相关优惠信息）； 2、【发现】类的爆料终端页正文内容： 1）新增“可能喜欢”的爆料入口，并加上跳转协议（跳至 爆料终端）； 3、【晒物】、【经验】2类的爆料终端页正文内容： 1）新增内容标签，加上点击协议（查看 搜索结果）；
mrobot接口
后端接口
爆料详细信息： http://best.pconline.com.cn/app/topic/getTopicInfo.do
eg： http://best.pconline.com.cn/app/topic/getTopicInfo.do?topicId=125405&fontSize=17&hd=0
读取评论总数： http://cmt.pconline.com.cn/action/topic/get_data.jsp
后端接口文档
说明
爆料详情终端页
缓存时间
1800s
提交方式
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 | 是 | |
| inReview | 审核状态 | int | 0 | 是 | 1-是，0-不是 |
返回格式
html
返回数据
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
showSource:1, //是否开放【去看看】，1是，0不是
commentCount:245, //评论数
commentId:45, //评论id
iphoneResVer:21000, //模板版本号（iOS请求时返回）
androidResVer:21000, //模板版本号（Android请求时返回）
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.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, //评论数
commentId:45, //评论id
iphoneResVer:21000, //模板版本号（iOS请求时返回）
androidResVer:21000, //模板版本号（Android请求时返回）
isOfficialPurchasing: 0 //0不支持官方代购，1支持官方代购 2.2.0新增
}
跳转协议：
优惠/海淘/发现 详情终端页:
正文字号的问题，跟前端和设计确认了，设计稿的尺寸到制作稿时要减半，所以正文的大中小字号应该分别为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.7 爆料关联的优惠信息（M）
（未完成）
需求：
新接口 返回该篇爆料关联的优惠券信息。 ps：mrobot请求应用后台提供优惠码接口和优惠券接口并合并数据，返回数据的data里返回对应的2个数组，优惠码在前。
mrobot接口
待补充
后端接口
爆料券码 http://best.pconline.com.cn/app/topicCouponRelation/cache/getTopicCouponRelationByTopic.do?pageNo=1&pageSize=10&isHot=1&isSpecial=1
爆料优惠券 http://best.pconline.com.cn/app/gift/cache/getTopicGiftList.do?pageNo=1&pageSize=10&isHot=1&isSpecial=1
后端接口文档
说明
返回该篇爆料关联的优惠信息
缓存时间
无
提交方式
GET
是否需要登录
否
参数（待定）
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| topicId | 爆料id | int | 0 | 是 | |
| v | 版本号 | int | 0 | 否 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
json
返回数据
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: {
discountCodes: [
{
id: 123456, //id
topicId: 123456, //爆料id
favorableCode: "亚马逊: aaaa1111aa", //优惠码
code: "aaaa1111aa", //纯优惠码
},
...
],
gifts: [
{//from $gift
createTime: 1449816795000, // 创建时间
discount: "25元无门槛", // 优惠券额度
expiryDate: 1450627199000, // 有效期
giftExchangeRule: { // 礼品兑换规则
giftId: 987,
limitTimes: 3,
needGold: 0,
needScore: 20,//所需金币
needDiamond: 998, // 兑换需要消耗的钻石 2.3.0新增
ruleId: 877
},
giftId: 987, //礼品id
giftPrice: 0, // 礼品价格
giftStock: { // 库存信息
changeNum: 877, // 已领取数量
createTime: 1449816795000,
giftId: 987,
stockNum: 2623, // 剩余库存
totalStockNum: 3500 // 总库存
},
imageUrl: "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1512/11/c3/16352638_1449816790509.png",
imgPath260x130: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/11/c3/spcgroup/width/16352638_1449816790509_260x130.png",
mallId: 261, // 电商Id
mallName: "网易考拉海购", // 电商名称
mallUrl: "http://www.kaola.com/activity/detail/6003.html?__da_m5KznQ_RYjvZV",
name: "网易考拉海购25元新人券", // 优惠券标题
orderNum: 0, // 排序
remainingDay: "5", // 当前时间距离优惠券过期的天数
status: 1, // 状态0：禁用；1：未领取；2：已领取
subGiftDesc: "1、新用户券，无门槛。老用户可通过注册新用户使用。</br>\r\n2、使用有效期2015年12月10日至12月20日。</br>\r\n3、领取后，到考拉海购官网兑换优惠券，兑换后2天内有效。</br>\r\n......",
type: 3
},
...
]
}
}
1.8 优惠券列表（M）
（未完成）
需求：
请求参数变动：新增3个参数 （无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”； 2）v：app版本号，如2.3.0； 3）inReview=1（Android端不传）； 返回数据变动： gift实体里新增1个字段 1、所需钻石数；
mrobot接口
后端接口
后端接口文档
说明
分页获取礼品列表，传入type为礼品的类型进行查找
缓存时间
无
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| type | 礼品类型： 1 礼品卡 2 实物礼品 3 优惠券 | int | 1 | 否 | |
| mallId | 电商id，0表示查找所有 | int | 0 | 否 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
json
返回数据
{
status: 1,
msg: "请求成功",
pageNo: 1,
pageSize: 20,
total: 100,
data: [
{//from $gift
createTime: 1449816795000, // 创建时间
discount: "25元无门槛", // 优惠券额度
expiryDate: 1450627199000, // 有效期
giftExchangeRule: { // 礼品兑换规则
giftId: 987,
limitTimes: 3,
needGold: 0,
needScore: 20,//所需金币
needDiamond: 998, // 兑换需要消耗的钻石 2.3.0新增
ruleId: 877
},
giftId: 987, //礼品id
giftPrice: 0, // 礼品价格
giftStock: { // 库存信息
changeNum: 877, // 已领取数量
createTime: 1449816795000,
giftId: 987,
stockNum: 2623, // 剩余库存
totalStockNum: 3500 // 总库存
},
imageUrl: "http://img.pconline.com.cn/images/upload/upc/tx/pc_best/1512/11/c3/16352638_1449816790509.png",
imgPath260x130: "http://imgrt.pconline.com.cn/images/upload/upc/tx/pc_best/1512/11/c3/spcgroup/width/16352638_1449816790509_260x130.png",
mallId: 261, // 电商Id
mallName: "网易考拉海购", // 电商名称
mallUrl: "http://www.kaola.com/activity/detail/6003.html?__da_m5KznQ_RYjvZV",
name: "网易考拉海购25元新人券", // 优惠券标题
orderNum: 0, // 排序
remainingDay: "5", // 当前时间距离优惠券过期的天数
status: 1, // 状态0：禁用；1：未领取；2：已领取
subGiftDesc: "1、新用户券，无门槛。老用户可通过注册新用户使用。</br>\r\n2、使用有效期2015年12月10日至12月20日。</br>\r\n3、领取后，到考拉海购官网兑换优惠券，兑换后2天内有效。</br>\r\n......",
type: 3
},
...
]
}
1.9 优惠券详情wap页（M）
（未完成）
需求：
正文内容变动： 1、领取优惠券花费的钻石数 附件信息变动： 1、增加领取优惠券需要花费的钻石数
mrobot接口：
后端接口
后端接口文档
说明
优惠券终端页
缓存时间
无
提交方式
GET
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| giftId | 礼品id | int | 0 | 是 | |
| fontSize | 字体大小 | int | 14 | 是 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
html
返回数据
html页面
html页面附加信息:
{
giftId: 1, // 礼品id
stockNum: 12, // 剩余库存
expiryDate: 13621321521000, // 有效期
remainingDay:2 // 当前时间距离优惠券过期的天数
}
1.10 领取优惠券
（未完成）
需求：
返回数据变动： 1、新增1个字段：钻石数； 2、data中的status新增因钻石数不足的情况；
后端接口
正式： 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 | 是 |
返回格式
json
返回数据
{
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 //用户的积分数
}
}
1.11 商品选择wap页（M）
（未完成）
需求：
页面内容变动： 1、【一键海淘】功能开放时，页面出商品选择页； 2、【一键海淘】功能关闭时，页面出信息提示页；
mrobot接口
http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/goods/showGoods.jsp?topicId=162832
后端接口
后端接口文档
说明
商品选择页面
缓存时间
无
提交方式
GET
是否需要登录
否
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| topicId | 爆料id | string | "" | 是 | |
| v | 版本号 | int | 0 | 是 | 2.3.0版本传v=2.3.0 |
| platform | 平台标识 | string | ”ios” | 是 | 传”ios”或”android” |
| inReview | 审核状态 | int | 0 | iOS必填，Android不填 | 1-是，0-不是 |
返回格式
html
返回数据
html页面
操作协议：
关闭页面点击协议：pcaction://close
确认商品点击协议：pcaction://finish-choosing?outerId={商品outerId} （不直接采用页面跳转协议，因为进入订单确认页需要先登录）
1.12 提交订单
（未完成）
需求：
请求参数：新增1个请求参数： 1）优惠码；（非必填）
mrobot接口
无
后端接口
http://best.pconline.com.cn/buy/appIntf/order/createOrder.jsp
后端接口文档
说明
提交订单
缓存时间
无
提交方式
POST
是否需要登录
是
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| outerId | 商品outerId | string | "" | 是 | |
| addrId | 用户地址id | string | "" | 是 | |
| goodOffCode | 折扣码 | string | "" | 否 | |
| common_session_id(cookie参数) | 登录sessionId | string | "" | 是 |
返回格式
json
返回数据
{
status: 1,
msg: "请求成功"
serviceDate: 111111111111111111 //系统时间毫秒数 2.3.0新增
data: {
orderId: 123456//订单id
orderNo: "1234567894123"//订单编号 2.3.0新增
pastDate: 111111111111111111111, //付款过期时间毫秒数 2.3.0新增
}
}
价格变动时返回：
result {
status: 12,
msg: '所购商品当前价格已上升至' 或 '所购商品当前价格已下降至',
data: {
curPrice: 100.00
}
}
1.13 订单信息（M）
（mrobot已完成开发，请连开发环境进行调试）
需求：
新接口
mrobot接口
后端接口
后端接口文档
说明
获取订单信息
缓存时间
无
提交方式
GET
是否需要登录
是
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|---|
| orderId | 订单Id | string | "" | 是 | |
| common_session_id(cookie参数) | 登录sessionId | string | "" | 是 |
返回格式
json
返回数据
{
status: 1,
msg: '请求成功',
serviceDate: '111111111111111111111111', //系统时间
data: {
orderId: 123456, //订单id
orderNo: "20151111123321", //订单编号 对应支付宝字段orderIdVar
amountPrice: 100000.00, //订单总价 对应支付宝字段totalPrice
status: 0, //订单状态
statusDesc: "待付款" //订单状态描述
pastDate: 111111111111111111111, //付款过期时间毫秒数
}
}
2 控制相关
2.1 url添加控制参数
（移动开发添加）
需求：
非提交数据的接口，特别是列表接口，请求参数添加3个控制参数 （无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”； 2）v：app版本号，如2.3.0； 3）inReview=1（Android端不传）
备注
1 跳转协议
聚超值V2.3.0跳转协议
说明：花括号代表参数值位置，使用时记得去掉花括号并填上对应值。
跳转协议——————————————————————————
---跳至 爆料终端
pconlinebestbuy://best-buy-article/{topicId}?type={type}&isOfficialPurchasing={isOfficialPurchasing}
跳转参数说明：
topicId：爆料id
type：爆料类型 //0优惠，1海淘，2 发现，3 晒物，4经验
isOfficialPurchasing：是否支持官方代购 //0不支持，1支持
---跳至 优惠券详情
pconlinebestbuy://best-coupon-detail/{giftId}
跳转参数说明：
giftId:礼品id（注意，这里是礼品id而不是优惠券id）
---跳至 代购商家
pconlinebestbuy://best-shop-list/{topicId}
跳转参数说明：
topicId：爆料id
---跳至 公共webView
pconlinebestbuy://best-outer-web/?url={url}
跳转参数说明：
url：外链链接
---跳至 大图浏览
pconlinebestbuy://best-big-photo/{topicId}?curIndex={curIndex}
跳转参数说明：
topicId：爆料id
curIndex：所点击图片的序号（从0算起）
操作协议——————————————————————
---关闭页面
pcaction://close
---确认商品
pcaction://finish-choosing?outerId={outerId}
参数说明：
outerId：商品编号
-—-立即付款
pcaction://buy-now?orderId={orderId}&amountPrice={amountPrice}
参数说明：
orderId：订单id
totalPrice：订单总价
---取消订单
pcaction://cancel-order?orderId={orderId}&status={status}
参数说明：
orderId：订单id
status：订单状态
---确认收货
pcaction://confirm-receipt?orderId={orderId}
参数说明：
orderId：订单id
---退款详情
pcaction://see-refund?orderId={orderId}
参数说明：
orderId：订单id
---查看税单
pcaction://see-taxBill?taxBillImageUrl={taxBillImageUrl}
参数说明：
taxBillImageUrl：税单图片链接
---查看 订单详情
pcaction://see-indent-detail?orderId={orderId}
跳转参数说明：
orderId：订单id
---查看 物流详情
pcaction://see-transfer-detail?orderId={orderId}
参数说明：
orderId：订单id
---查看 全部订单
pcaction://see-my-indents?type={type}
参数说明：
type：订单类型 //0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单
---查看 关于关税
pcaction://about-tariff?text={text}
参数说明：
text：关税提示文案
--- 弹窗
pcaction://show-alert?title={title}&msg={msg}
参数说明：
title：弹窗标题（可选）
msg：弹窗内容（必填）
--- 查看 搜索结果
pcaction://search-result?searchType={searchType}&searchCondition={searchCondition}&index={index}
参数说明：
searchType：搜索类型。1 按分类搜索, 2 按电商搜索, 3 按标签搜索, 4 按关键词搜索
searchCondition：搜索条件。1(分类id), 2(电商名称),3(标签名称),4（关键词）
index：默认选中的列表类型。 0优惠，1海淘，2 发现，3 晒物，4经验
--- 查看 爆料相关优惠券
pcaction://show-topic-coupons?topicId={topicId}
参数说明：
topicId：爆料id
