wiki:price_api_2.2.0

Context Navigation

Version 9 (modified by oujianqiang, 10 years ago) (diff)
--

聚超值2.1.0接口文档

一.基本约定

  1.开发机、测试机代理地址：
  mrobot开发机代理：192.168.10.199  端口：1080
  mrobot测试机代理：192.168.10.198  端口：1080
  电脑网应用端测试环境域名  v42.pconline.com.cn
  电脑网应用端线上环境域名  best.pconline.com.cn
  mrobot线上环境域名：mrobot.pconline.com.cn
  mrobot测试环境域名：v80.pconline.com.cn
  mrobot开发环境域名：dev40.pconline.com.cn

  2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
  
  3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。
      {
         "desc":"给用户的提示放在这里"
      }
      
  4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。
  
  5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。
  
  6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号
  
  7.需要分页的接口，统一返回以下字段:  pageNo,pageSize,total

二.接口列表

1 一键海淘

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

需求：
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[[BR]]

后端接口

栏目爆料列表

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

说明

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

缓存时间

300s

提交方式

GET

是否需要登录

否

参数

参数名	参数含义	类型	默认值	是否必须	备注
sectionId	栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题	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需求:新增字段】
        }
        ...
    ]
}

1.2爆料详情终端页

需求：
1、页面附加信息：新增一个标签字段isOfficialPurchasing，用于标记爆料是否支持代购；

mrobot接口

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

后端接口

爆料详细信息 eg： http://best.pconline.com.cn/app/topic/getTopicInfo.do?topicId=125405&fontSize=17&hd=0
评论数接口 eg： http://cmt.pconline.com.cn/action/topic/get_data.jsp?url=http://best.pconline.com.cn/discovery_art.jsp?topicId=125405[[BR]]

说明

爆料详情终端页

缓存时间

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	是

返回格式

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
  commentCount:245 //评论数 【V2.1.0需求:新增字段，请求评论数接口获取】
  commentId:45 //评论id 【V2.1.0需求:新增字段，请求评论数接口获取】
  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 //评论数 【V2.1.0需求:新增字段，请求评论数接口获取】
  commentId:45 //评论id 【V2.1.0需求:新增字段，请求评论数接口获取】
  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页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

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

后端接口文档

商品选择

说明

商品选择页面

缓存时间

无

提交方式

GET

是否需要登录

否

参数

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

返回格式

html

返回数据

html页面

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

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

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

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

后端接口文档

商品信息确认

说明

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

缓存时间

无

提交方式

GET

是否需要登录

是

参数

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

返回格式

json

返回数据

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

1.5获取默认收货地址

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

1.6校验订单

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

1.7提交订单

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

1.8支付结果wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

1.9官方代购服务条款wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

1.10一键海淘须知wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2 地址管理

2.1添加收货地址

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2.2上传身份证

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2.3收货地址列表

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2.4设置默认收货地址

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2.5删除收货地址

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

2.6修改收货地址

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3 订单管理

3.1订单列表

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3.2取消订单

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3.3确认收货

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3.4订单详情wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3.5物流详情wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

3.6退款详情wap页

需求：
1、新接口；

mrobot接口

（待补充）

后端接口

后端接口文档

说明

缓存时间

提交方式

GET

是否需要登录

参数

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

返回格式

html

返回数据

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

Download in other formats:

Plain Text

Context Navigation

Table of Contents

聚超值2.1.0接口文档

一.基本约定

二.接口列表

1 一键海淘

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

1.2爆料详情终端页

1.3商品选择wap页

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

1.5获取默认收货地址

1.6校验订单

1.7提交订单

1.8支付结果wap页

1.9官方代购服务条款wap页

1.10一键海淘须知wap页

2 地址管理

2.1添加收货地址

2.2上传身份证

2.3收货地址列表

2.4设置默认收货地址

2.5删除收货地址

2.6修改收货地址

3 订单管理

3.1订单列表

3.2取消订单

3.3确认收货

3.4订单详情wap页

3.5物流详情wap页

3.6退款详情wap页

Download in other formats: