wiki:price_api_2.2.0

Context Navigation

一.基本约定
二.接口列表
1 一键海淘
2 地址管理
3 订单管理
4 服务协议与举报
1. 4.1服务协议wap页（M）
2. 4.2举报wap页（M）
备注
1 跳转协议

聚超值2.2.0接口文档

一.基本约定

  1.开发机、测试机代理地址：
  mrobot开发机代理：192.168.10.199  端口：1080
  mrobot测试机代理：192.168.10.198  端口：1080
  电脑网应用端测试环境域名  v72.pconline.com.cn:8002
  电脑网应用端线上环境域名  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

二.接口列表

1 一键海淘

1.1优惠、海淘、发现、晒物、经验列表数据接口（M）

（mrobot已完成开发，请连开发机进行测试）
需求：
1、topic实体新增一个字段 isOfficialPurchasing，用于区分爆料是否支持官方代购；

mrobot接口

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&v=2.2.0

后端接口

http://best.pconline.com.cn/app/topic/cache/getTopicList.do

eg： http://best.pconline.com.cn/app/topic/cache/getTopicList.do?pageNo=0&pageSize=20&sectionId=0

后端接口文档

栏目爆料列表

说明

根据传入的栏目id，获取对应的爆料列表

缓存时间

300s

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注
sectionId	栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验	int	0	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0
inReview	审核状态	int	0	否	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支持官方代购【V2.2.0需求:新增字段】
        }
        ...
    ]
}

$topic

1.2爆料详情终端页（M）

（mrobot已完成开发，请连开发机进行测试）
需求：
1、页面附加信息：新增一个标签字段isOfficialPurchasing，用于标记爆料是否支持代购；
2、APP上线后（根据请求参数的inReview字段判断，0——已上线，1——正在审核），隐藏页面的举报按钮；

mrobot接口

http://mrobot.pconline.com.cn/s-1800/best/cms/topicDetail.xsp?topicId=125405&platform=iOS&v=2.2.0&resVer=21000&inReview=0

后端接口

爆料详细信息： 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

eg： http://cmt.pconline.com.cn/action/topic/get_data.jsp?url=http://best.pconline.com.cn/discovery_art.jsp?topicId=125405

后端接口文档

爆料详细信息读取评论总数

说明

爆料详情终端页

缓存时间

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支持官方代购【V2.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支持官方代购【V2.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.3商品选择wap页（M）

（mrobot已完成开发，请连开发机进行测试）
mrobot接口

http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/goods/showGoods.jsp?topicId=162832

后端接口

http://best.pconline.com.cn/buy/appIntf/goods/showGoods.jsp

后端接口文档

商品选择

说明

商品选择页面

缓存时间

无

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注
topicId	爆料id	string	""	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0

返回格式

html

返回数据

html页面

操作协议：
关闭页面点击协议：pcaction://close
确认商品点击协议：pcaction://finish-choosing?outerId={商品outerId} （不直接采用页面跳转协议，因为进入订单确认页需要先登录）

1.4根据商品编码获取商品信息

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/goods/checkGoods.jsp

后端接口文档

商品信息确认

说明

根据商品编码获取商品信息

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
outerId	商品outerId	string	""	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  data: {
           goodsItemId: 123456,
           outerId: "BO1234564", //outerId
           enName: "ECCO Men's Dress Moccasin Penny Loafer",        //商品标题
           property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black", //商品参数  有些商品没有参数  此项为""
           imgUrl: "xxx.xxxx...",  //商品图片
           cnPrice: 123.00,        //人民币单价
           frPrice: 20.00,         //美元单价
           itemCnPrice: 123.00     //商品总价  单价*数量
           tariffCharge: 120.00,   //关税
           expCharge: 123.00,      //运费
           appExpCharge: 103.00,   //app优惠运费   无优惠该值为负数
           totalPrice: 100000.00,  //订单总价
           quantity: 1,            //商品购买数量
           mallId: 123,            //电商id
           mallName: "美国亚马逊"  //电商名称
        }
}

1.5获取默认收货地址（M）

（mrobot已完成开发，请连开发机进行测试）
需求：
1、新接口；

mrobot接口

http://mrobot.pconline.com.cn/s/best/buy/getDefaultAddress.xsp

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/getDefaultAddress.jsp

后端接口文档

获取默认收货地址

说明

获取默认收货地址

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
common_session_id(cookie参数)	登录sessionId	string	""	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  data: {
             addrId: 123456,           //地址Id
             name: "rico",               //用户名
             province: "13-河北",        //省
             city: "1303-秦皇岛",        //城市
             county: "130324-卢龙县",   //县，区
             phone: "15952352365",       //电话 
             detail: "广州市天河区天河软件园高普路115号太平洋网络",      //详细地址
             idcardNo: "445185455623562955",                             //身份证号码
             idcardImga: "http://img.pconline.com.cn/images/upload/upc/tx/pcbest_buy/a.jpg",     //身份证正面
             idcardImgb: "http://img.pconline.com.cn/images/upload/upc/tx/pcbest_buy/b.jpg",     //身份证反面
             postcode: "510006"        //邮政编码
        }
  
}

1.6提交订单

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/order/createOrder.jsp

后端接口文档

提交订单

说明

提交订单

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须
outerId	商品outerId	string	""	是
addrId	用户地址id	string	""	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  data: {
             orderId:  123456//订单id
        }
}

价格变动时返回：
result {
  status: 12,
  msg: '所购商品当前价格已上升至' 或 '所购商品当前价格已下降至',
  data: {
             curPrice: 100.00
        }
}

1.7支付数据

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/pay/payInfoByOrder.jsp

后端接口文档

用户订单支付数据

说明

获取用户订单支付数据，如实际支付金额等。每次使用第三方支付前必须调用该接口获取支付相关数据，接口返回的status不等于1时则订单无效。

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
    status: 1,
    msg: '请求成功',
    data: {
           orderId: 123456,             //订单id
           orderNo: "20151111123321",   //订单编号  对应支付宝字段orderIdVar
           enName: "ECCO Men's Dress Moccasin Penny Loafer" //商品标题,也用于商品描述  对应支付宝字段enName和description
           amountPrice: 100000.00           //订单总价  对应支付宝字段totalPrice
           pastDate: 111111111111111111111, //付款过期时间毫秒数
           payCallbackUrl: "xxx.xxx..."     //支付宝回调url
         }
  
}

1.8支付成功wap页

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/pay/successFeedback.jsp

后端接口文档

支付成功

说明

提示用户支付成功后的页面

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

html

返回数据

html页面

操作协议：
查看我的订单：pcaction://see-my-indents?type={type类型} type类型：订单类型 0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单
查看订单详情：pcaction://see-indent-detail?orderId={订单id}

1.9支付失败wap页

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/pay/failFeedback.jsp

后端接口文档

支付失败

说明

提示用户支付失败的页面

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

html

返回数据

html页面

操作协议：
查看我的订单：pcaction://see-my-indents?type={type类型} type类型：订单类型 0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单
立即支付：pcaction://buy-now?orderId=={订单id}&amountPrice=={订单总金额}

1.10官方代购服务条款wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/x-86400/best-best/buy/appIntf/clause.html

后端接口

http://best.pconline.com.cn/buy/appIntf/clause.html

后端接口文档

官方代购服务条款页面

说明

官方代购服务条款页面

缓存时间

24min

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注
v	版本号	int	0	否	2.2.0版本传v=2.2.0
inReview	审核状态	int	0	否	1-是，0-不是

返回格式

html

返回数据

html页面

1.11一键海淘须知wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/x-86400/best-best/buy/appIntf/notice.html

后端接口

http://best.pconline.com.cn/buy/appIntf/notice.html

后端接口文档

一键海淘须知

说明

一键海淘须知

缓存时间

24min

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注
v	版本号	int	0	否	2.2.0版本传v=2.2.0
inReview	审核状态	int	0	否	1-是，0-不是

返回格式

html

返回数据

html页面

1.12 首页精选列表数据接口（M）

(接口已完成，请连开发机进行测试)

需求：
1、topic实体新增一个字段 isOfficialPurchasing，用于区分爆料是否支持官方代购；
2、focusImage实体新增一个字段 isOfficialPurchasing，用于区分爆料是否支持官方代购；

mrobot接口

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=2.2.0

后端接口

首页精选数据接口： 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.2.0

后端接口文档

首页数据接口焦点图

说明

获取推荐首页列表数据 + 焦点图（另外的接口，当pageNo为1时返回）

缓存时间

300s

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
v	版本号	int	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支持官方代购【V2.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支持官方代购【V2.2.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.13 搜索接口（M）

（mrobot已完成，请连开发机进行测试）

需求：
1、topic实体新增一个字段 isOfficialPurchasing，用于区分爆料是否支持官方代购；

mrobot接口：

http://mrobot.pconline.com.cn/s-300/best/search/listTopicSearch.xsp

后端接口

http://best.pconline.com.cn/app/search/listTopicSearch.do

后端接口文档

搜索接口

说明

分类搜索返回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支持官方代购【V2.2.0需求:新增字段】
        },
        ...
    ],
    searchSectionResults: [
        {// from $sectionExtend
            value: 1,
            name: '海淘',
            count: 12  
        },
        ...
    ]
  }
}

$topic $sectionExtend

1.14 收藏列表（M）

（mrobot已完成，请连开发机进行测试）

需求：
1、topic实体新增一个字段 isOfficialPurchasing，用于区分爆料是否支持官方代购；

mrobot接口：

http://mrobot.pconline.com.cn/s/best/my/listMyCollects.xsp

后端接口

http://best.pconline.com.cn/app/my/collect/listCollects.do

后端接口文档

获取收藏列表

说明

用于网友个人中心获取收藏列表

缓存时间

无

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
index	0 优惠 1 海淘 2 发现 3 晒物 4 经验	int	0	是

返回格式

json

{
  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,
        isOfficialPurchasing: 0  //0不支持官方代购，1支持官方代购【V2.2.0需求:新增字段】
      }
  ]
}

$favorite

2 地址管理

2.1添加收货地址

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/addUserAddress.jsp

后端接口文档

添加收货地址

说明

添加收货地址

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id(cookie参数)	登录sessionId	string	""	是
name	收货人名字	string	""	是
province	省份	string	""	是
city	城市	string	""	是
county	县区	string	""	是
phone	手机号码	string	""	是
detail	详细地址	string	""	是
idcardNo	身份证号码	string	""	是
idcardImga	身份证正面链接	string	""	是
idcardImgb	身份证反面链接	string	""	是
postcode	邮政编码	string	""	是
isdefault	默认地址	int	0	否

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  
}

2.2上传身份证

mrobot接口

无

后端接口

http://upc.pconline.com.cn/upload_quick.jsp

后端接口文档

普通文件upload_quick.jsp

说明

图片上传

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
common_session_id(cookie参数)	登录sessionId	string	""	是
windowname	如果不为空，上传后的json将放在window.name属性中返回	string	""	否
application	应用名称	string	""	是	聚超值填 bestbuy
keepSrc	是否保留原始文件	string	yes	是
readExif	是否读取exif信息	string	yes	否
command	处理指令id	string	""	否
rotate	需要旋转的角度0-360	string	""	否
waterMark	水印文件名(指定文件必须已经在上传服务器的相应应用目录下)	string	""	否
frame	相框文件名(指定文件必须已经在上传服务器的相应应用目录下)	string	""	否

返回格式

json

返回数据

返回（json）：
    失败：{retCode: xxx}
    成功：
    返回示例:
    {"files":[
              {"fileSize":25066,"exif":"image_height=768 pixels,white_balance=Auto,image_width=1024 pixels,date_time=2009:03:12 13:47:43","height":202,"rid":2018967,"width":270,"fileName":"1214446_1414050558889_270x202.jpg","audit":"New","orgFileName":"Desert.jpg","isorg":0,"url":"http://dev2.pcgames.com.cn:9191/auto5/1410/23/c0/1214446_1414050558889_270x202.jpg"},
              {"fileSize":41183,"exif":"image_height=768 pixels,white_balance=Auto,image_width=1024 pixels,date_time=2009:03:12 13:47:43","height":260,"rid":2018966,"width":350,"fileName":"1214446_1414050558889_350x260.jpg","audit":"New","orgFileName":"Desert.jpg","isorg":0,"url":"http://dev2.pcgames.com.cn:9191/auto5/1410/23/c0/1214446_1414050558889_350x260.jpg"},
              {"fileSize":845941,"exif":"image_height=768 pixels,white_balance=Auto,image_width=1024 pixels,date_time=2009:03:12 13:47:43","height":768,"rid":2018965,"width":1024,"fileName":"1214446_1414050558889.jpg","audit":"New","orgFileName":"Desert.jpg","isorg":1,"url":"http://dev2.pcgames.com.cn:9191/auto5/1410/23/c0/1214446_1414050558889.jpg"}],
        "retCode":0,"tid":1214446}

    说明：
    retCode: 返回状态码,具体请参考"upc状态码说明"
    tid: 事务id
    rid: 图片资源id
    fileName: 图片名称
    url: 图片路径
    orgFileName: 源文件名称
    width: 宽
    height: 高
    isorg: 是否原图，1表示原图，0不是原图
    audit: 审核状态，默认为未审核
    exif: 图片exif信息
    fileSize: 文件大小

2.3收货地址列表（M）

（mrobot已完成开发，请连开发机进行测试）
需求：
1、新接口；

mrobot接口

http://mrobot.pconline.com.cn/s/best/buy/listUserAddress.xsp

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/listUserAddress.jsp

后端接口文档

获取用户的地址列表

说明

获取用户的地址列表

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功",
  data: [
            {
             addrId: 123456,            //地址Id
             name: rico,                //用户名
             province: 13-河北,         //省
             city: 1303-秦皇岛,         //城市
             county: 130324-卢龙县,    //县，区
             phone: 15952352365,        //电话 
             detail: 广州市天河区天河软件园高普路115号太平洋网络,      //详细地址
             idcardNo: 445185455623562955,                             //身份证号码
             idcardImga: http://img.pconline.com.cn/images/upload/upc/tx/pcbest_buy/a.jpg,     //身份证正面
             idcardImgb: http://img.pconline.com.cn/images/upload/upc/tx/pcbest_buy/b.jpg,     //身份证反面
             postcode: 510006,        //邮政编码
             isdefault: 0            //是否默认地址 1是，0否
           }
        ]
  
}

2.4设置默认收货地址

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/setDefaultAddress.jsp

后端接口文档

设置默认地址

说明

设置用户的默认地址

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
addrId	用户地址id	string	""	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  
}

2.5删除收货地址

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/deleteUserAddress.jsp

后端接口文档

删除地址

说明

删除地址

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
addrId	用户地址id	string	""	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  
}

2.6修改收货地址

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/useraddress/updateUserAddress.jsp

后端接口文档

修改收货地址

说明

修改收货地址

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id(cookie参数)	登录sessionId	string	""	是
addrId	用户地址id	string	""	是
name	收货人名字	string	""	是
province	省份	string	""	是
city	城市	string	""	是
county	县区	string	""	是
phone	手机号码	string	""	是
detail	详细地址	string	""	是
idcardNo	身份证号码	string	""	是
idcardImga	身份证正面链接	string	""	是
idcardImgb	身份证反面链接	string	""	是
postcode	邮政编码	string	""	是
isdefault	默认地址	int	0	否

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  
}

3 订单管理

3.1订单列表（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/s/best/buy/orderList.xsp?type=0&pageNo=1&pageSize=10

后端接口

http://best.pconline.com.cn/buy/appIntf/order/orderList.jsp

后端接口文档

用户订单列表

说明

请求用户的订单列表

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	第几页	int	1	是
pageSize	一页的数据量	int	10	是
type	0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功"
  
    pageNo: 1,
    pageSize: 10,
    total: 20,
    pageTotal: 2,
    serviceDate: 111111111111111111 //系统时间毫秒数
    data: [
        {
           orderId: 123456,           //订单id
           orderNo: "20151111123321", //订单编号
           enName: "ECCO Men's Dress Moccasin Penny Loafer",        //商品标题
           property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black",  //商品参数 有些商品没有参数  此项为""
           imgUrl: "xxx.xxxx...",           //商品图片
           cnPrice: 123.00,                 //人民币单价
           frPrice: 20.00,                  //美元单价
           itemCnPrice: 123.00              //商品总价  单价*数量
           tariffAmountprice: 120.00,       //关税
           expAmountprice: 123.00,          //运费
           amountPrice: 100000.00,          //订单总价
           status: 1,                       //订单状态
           statusDesc: "已取消",            //订单状态描述
           pastDate: 111111111111111111111, //付款过期时间毫秒数
           quantity: 1,                     //商品数量
           mallId: 123,                     //电商id
           mallName: "美国亚马逊"           //电商名称
        }
    ]
}

3.2取消订单

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/order/cancelOrder.jsp

后端接口文档

取消订单

说明

取消用户某个订单订单状态为未付款（status == 0）或官方未审核（status == 1）的订单才能够取消

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功",
  data: {
            orderId:123456 //取消订单的id
        }
  
}

3.3确认收货

需求：
1、新接口；

mrobot接口

无

后端接口

http://best.pconline.com.cn/buy/appIntf/order/confirmReceive.jsp

后端接口文档

确认收货

说明

将订单状态改为已收货订单发货后（status == 7）才能以确认收货

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是

返回格式

json

返回数据

{
  status: 1,
  msg: "请求成功",
  data: {
            orderId:123456 //修改的订单id
        }
  
}

3.4订单详情wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/order/orderDetail.jsp?orderId=1504

后端接口

http://best.pconline.com.cn/buy/appIntf/order/orderDetail.jsp

后端接口文档

订单详情

说明

订单详情

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0

返回格式

html

返回数据

html页面

3.5物流详情wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/transfer/transferInfo.jsp?orderId=2206

后端接口

http://best.pconline.com.cn/buy/appIntf/transfer/transferInfo.jsp

后端接口文档

转运轨迹

说明

订单的物流详情页面

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0

返回格式

html

返回数据

html页面

3.6退款情况（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/s/best/buy/refundLog.xsp?orderId=1708

后端接口

http://best.pconline.com.cn/buy/appIntf/refund/refundLog.jsp

后端接口文档

退款记录

说明

退款记录

缓存时间

无

提交方式

GET

是否需要登录

是

参数

参数名	参数含义	类型	默认值	是否必须	备注
orderId	订单id	int	0	是
common_session_id(cookie参数)	登录sessionId	string	""	是
v	版本号	int	0	否	2.2.0版本传v=2.2.0

返回格式

json

返回数据

result {
        status: 1,
        msg: '请求成功',

        //订单无赔付记录时，data为null
        data: {
                   accountName: "tom",                  //用户账号名称
                   serviceName: "xiaoming",             //客服账号
                   title: "通过审核",                   //处理结果
                   result: "您的赔付申请已通过......"   //结果说明
                   date: 11111111111111111             //处理时间
                }
        
}

4 服务协议与举报

4.1服务协议wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/s-86400/best/cms/protocol.xsp

后端接口

无

后端接口文档

无

说明

太平洋网络服务条款及使用协议

缓存时间

24h

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注

返回格式

html

返回数据

html页面

4.2举报wap页（M）

（mrobot已完成开发，请连开发机进行测试）

mrobot接口

http://mrobot.pconline.com.cn/s/best/bbs/report.xsp?isBBS=0&topicId=123&postId=0

后端接口

无

后端接口文档

无

说明

太平洋网络服务条款及使用协议

缓存时间

无

提交方式

POST

是否需要登录

是

参数

参数名	类型	必须	说明
isBBS	string	是	判断举报是否来自帖子终端页，isBBS=1时来自帖子；isBBS=0时来自文章
topicId	string	是	帖子id或文章id
postId	string	是	楼层id，当举报来自文章评论时postId=0

返回格式

html

返回数据

html页面

备注

1 跳转协议

聚超值V2.2.0跳转协议

说明：花括号代表参数值位置，使用时记得去掉花括号并填上对应值。

跳转协议——————————————————————————

---跳至 爆料终端
pconlinebestbuy://best-buy-article/{topicId}?type={type}&isOfficialPurchasing={isOfficialPurchasing}&isRecommendedTopic={isRecommendedTopic}
跳转参数说明：
topicId：爆料id
type：爆料类型  //0优惠，1海淘，2 发现，3 晒物，4经验
isOfficialPurchasing：是否支持官方代购  //0不支持，1支持
isRecommendedTopic：是否推荐爆料（猜你喜欢） //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：弹窗内容（必填）

Download in other formats:

Plain Text

Context Navigation

Table of Contents

聚超值2.2.0接口文档

一.基本约定

二.接口列表

1 一键海淘

1.1优惠、海淘、发现、晒物、经验列表数据接口（M）

1.2爆料详情终端页（M）

1.3商品选择wap页（M）

1.4根据商品编码获取商品信息

1.5获取默认收货地址（M）

1.6提交订单

1.7支付数据

1.8支付成功wap页

1.9支付失败wap页

1.10官方代购服务条款wap页（M）

1.11一键海淘须知wap页（M）

1.12 首页精选列表数据接口（M）

1.13 搜索接口（M）

1.14 收藏列表（M）

2 地址管理

2.1添加收货地址

2.2上传身份证

2.3收货地址列表（M）

2.4设置默认收货地址

2.5删除收货地址

2.6修改收货地址

3 订单管理

3.1订单列表（M）

3.2取消订单

3.3确认收货

3.4订单详情wap页（M）

3.5物流详情wap页（M）

3.6退款情况（M）

4 服务协议与举报

4.1服务协议wap页（M）

4.2举报wap页（M）

备注

1 跳转协议

Download in other formats: