wiki:price_api

Context Navigation

Version 36 (modified by oujianqiang, 11 years ago) (diff)
--

聚超值2.0.0接口文档

一.基本约定

  1.开发机、测试机代理地址：
  mrobot开发机代理：192.168.10.199  端口：1080
  mrobot测试机代理：192.168.10.198  端口：1080
  
  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.首页列表数据接口

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

homepageList

后端接口

首页数据接口焦点图

说明

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

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    status: 0, 
    msg: "请求成功",
    pageNo: 1,
    pageSize: 20,
    pageTotal: 2168,
    total: 43357
    serverTime: 1426036331,
    focus: [//焦点图
        {//from $focusImage
            "topicId": 125,  // 爆料id
            "topicType": 1  // 顶级的栏目id：0优惠，1海淘，2 发现，3 晒物，4经验
            "image": "http://img.pconline.com.cn/7.jpg",  // 焦点图
            "title": "哪家最低？MacBook/Watch美港日扫货攻略",
        }
        ...
    ]
    listIndex:[
        {
            type:1 // 1 爆料
            value:{//from $topic
                topicId: 2395585,
                title: "有钱你就来",  //标题
                topicType: 1  // 0优惠，1海淘，2 发现，3 晒物，4经验
                mallName: "京东",  // 电商名称
                mallId: 1, // 电商id
                price: "五折对低价199",  // 价格描述
                pubDate: "2015-03-10 07:31:47",  // 发布时间,时间戳 毫秒
                overdueStatus: 1,  // 是否过期
                endTime: "2015-03-15 07:31:47",  // 优惠截止时间
                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块包邮",
                    image: "http://img.pconline.com.cn/7.jp",
                    topicId: 23412
                    seq:3  // 排序，插入到首页的位置
            }
        }
        {
            type:4 // 4 优惠券
            value:{//from $giftCoupon
                couponId: 123,  // 优惠券Id
                giftId: 123,  // 礼品Id
                mallName: '京东',  // 电商名称
                image: "http://a.cn/1.png",  // 图片
                disCount: "满400减20",  // 优惠券额度
                status: 1,  // 状态0：禁用；1：未领取；2：已领取
                expiryDate: 13621321521000,  // 有效期
            }
        }
        ...
    ]
}

$focusImage $topic $adPosition $giftCoupon

2.优惠、海淘、发现、试用体验、专题列表数据接口

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

topicList

后端接口

栏目爆料列表

说明

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

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
sectionId	栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题	int	0	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    status: 0, 
    msg: "请求成功",
    pageNo: 1,
    pageSize: 20,
    pageTotal: 2168,
    total: 43357
    serverTime: 1426036331,
    data:[
        {//from $topic
            topicId: 2395585,
            title: "有钱你就来",  //标题
            topicType: 1  // 0优惠，1海淘，2 发现，3 晒物，4经验
            mallName: "京东",  // 电商名称
            mallId: 1, // 电商id
            price: "五折对低价199",  // 价格描述
            pubDate: "2015-03-10 07:31:47",  // 发布时间,时间戳 毫秒
            overdueStatus: 1,  // 是否过期
            endTime: "2015-03-15 07:31:47",  // 优惠截止时间
            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  // 是否白菜价合集
        }
        ...
    ]
}

$topic

3.获取用户某个时间之后的爆料数和评论数

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

getNewsCount

后端接口

获取用户某个时间之后的爆料数和评论数

说明

获取用户某个时间之后的爆料数,评论数和试用数

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id（HTTP Header的Cookie中）	-	String	""	是
lastAccessTime	最近一次访问该接口的时间	long(时间戳秒)	当前时间	是

{
  status: 0,
  msg: "请求成功",
  data: {
    newTopicCount: 100,
    newCommentCount: 1,
    newSystemNoticeCount: 1
  }
}

4.单篇爆料、晒物、经验、体验报告、专题终端页（Web）

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

topicDetail

后端接口

爆料详细信息

说明

单篇爆料或者晒物、经验、体验报告、专题终端页

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是
fontSize	字体大小	int	14	是
hd	是否显示高清图：0 否 1 是	int	0	否

  web页面的html代码，内嵌JSON格式的附加信息，以及点击交互的跳转协议
  附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾

  >>>>>>>>>>附加信息:
  {
    bestBuyLink:"bestbuy://topic-1.cc"  // 直达链接，可能是自定义的协议或者普通的url
  }
  <<<<<<<<<<



  >>>>>>>>>>跳转协议：

  ---跳转进入优惠券详情 点击爆料详情终端页的"优惠券"内时触发
  pconlinebestbuy://bestbuy-giftCoupon-detail?giftId={giftId}
  跳转参数说明：
  giftId：礼品id

  ---跳转浏览大图 点击爆料详情终端页的任一张图片时触发
  pconlinebestbuy://bestbuy-show-photo?topicId={topicId}&currentIndex={currentIndex}
  跳转参数说明：
  topicId：爆料id
  currentIndex：图片序号

  ---跳转进入商家列表 点击爆料详情终端页的"有**家商家可代购"时触发
  pconlinebestbuy://bestbuy-purchasing-list?topicId={topicId}
  跳转参数说明：
  topicId：爆料id

  ---跳转进入商家淘宝商品页 点击爆料详情终端页底部的"推挤代购商家"时触发
  pconlinebestbuy://bestbuy-purchasing-dg-terminal?link={link}
  跳转参数说明：
  link：代购地址

  <<<<<<<<<<

5.判断用户是否已收藏爆料

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

checkTopicCollectStatus

后端接口

判断用户是否已收藏爆料

说明

判断用户是否已收藏爆料

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
topicId	爆料id	int	0	是

{
  status: 0,
  msg: "请求成功",
  hasCollect: 0// 0 表示未收藏   1 表示已收藏
}

6.收藏

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

collectOneTopic

后端接口

收藏

说明

收藏

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
topicId	爆料id	int	0	是

{
  status: 0,
  msg: "收藏成功"
}

7.取消收藏

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

decollectOneTopic

后端接口

取消收藏

说明

取消收藏

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
topicId	爆料id	int	0	是

{
  status: 0,
  msg: "取消收藏成功"
}

8.获取爆料赞和踩的数量

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

getTopicLikeAndDislikeCount

后端接口

获取爆料赞和踩的数量

说明

用于终端页显示爆料的赞和踩的数量

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是

{
  status: 0,
  msg: "请求成功",
  data: {
    goodCount: 12,
    badCount: 1,
    isVoted: 0
  }
}

9.赞或者踩

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

likeAndDislike

后端接口

赞或者踩

说明

对爆料点赞或踩

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是
operate	操作：0 赞 1 踩	int	0	是

{
  status: 0,
  msg: "感谢您的投票",
}

10.爆料正文中图片集列表

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

topicImagesList

后端接口

获取爆料正文中的图片集

说明

从终端页中获取到所有上传的图片，用于浏览图模式

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是

{
  status: 0,
  msg: "请求成功",
  total: 100,
  data: [
    {
      url: "http://img/pc.com.cn/1.png",
      url: "http://img/pc.com.cn/2.png",
      ...
    }
  ]
}

11.代购商家列表

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

purchasingList

后端接口

获取爆料的代购列表

说明

获取代购列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是
pageNo	页数	int	1	否
pageSize	页面大小	int	10	否

{
  status: 0,
  msg: "请求成功",
  total: 100,
  data: {//from $purchasing
      description: "超值代购",  //代购商家描述
      hasSpotGoods: 1,  // 是否有现货：0 现货/1 代购
      link: "http://www.taobao.com/item_1.html"  //代购地址  
      name: "Jason",  //用户名
      nickName: "Jason",  //昵称
      logo: "http://img.pc.com.cn/1.png",  //头像 从平台获取
      price: 128,  //价格 
  }
}

$purchasing $user

12.求代购

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

addTopicBuyCount

后端接口

求代购

说明

求代购

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
topicId	爆料id	int	0	是
price	求购价	int	0	否
name	称呼	String	""	是
contactWay	联系类型 1:手机号码 2：旺旺号码 3:QQ号码	int	0	是
contactInfo	联系方式	String	""	是

{
  status: 0,
  msg: "申请成功"
}

13.优惠券终端页（Web）

mrobot接口：（mrobot补充）

开发环境url：

测试环境url：

接口名：（mrobot接口补充后可删除掉）

giftDetail

后端接口

优惠券信息

说明

优惠券终端页

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
giftId	礼品id	int	0	是
fontSize	字体大小	int	14	是

  web页面的html代码，内嵌JSON格式的附加信息，以及点击交互的跳转协议
  附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾

  >>>>>>>>>>附加信息:
  {
      （暂无）
  }
  <<<<<<<<<<



  >>>>>>>>>>跳转协议：

  ---领取优惠券 点击优惠券详情底部的“领取优惠券”按钮时触发
  pconlinebestbuy://bestbuy-get-giftCoupon?giftId={giftId}&giftName={giftName}&needScore={needScore}&needGold={needGold}
  跳转参数说明：
  giftId：礼品id
  giftName：优惠券概要信息
  needScore：兑换所需积分
  needGold：兑换多需金币

  <<<<<<<<<<

14.广场数据接口

sunplaza

后端接口

广场数据接口获取新通过的试用数

说明

获取广场首页需要的内容. 获取新通过的试用数来显示红点及红点上的数量; 判断是否的: 0为否,1为是

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  data:{
     sunplazaEntrys: [
         {//from $sunplazaEntry
            type: 1,  // 1 标签爆料列表，2 分类爆料列表，3 电商爆料列表，4 爆料终端页，5 专题页，6 试用详情页，7 外链，8 搜索结果页，9商家优惠券列表
            value: {tagId or mallId or catId or {topicId,topSection} or trialId or url or keyword},
            icon: "http://img.pconline.com.cn/1.png",
            name: "白菜价"
        }，
        ...
     ],//四个自由快捷入口
     hotSpecial: {
        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,
            appCover: "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: {
        giftId: 1
        name: "京东卡",
        mallName: '京东',  // 电商名称
        imageUrl: "http://a.cn/1.png",  // 图片
        giftPrice: 12.00,  // 礼品价格
        createTime: 13251245124000,  // 创建时间
        disCount: "满400减20",  // 优惠券额度
        expiryDate: 13621321521000,  // 有效期
        mallId:  12,  // 电商Id
        remainingDay:2  // 当前时间距离优惠券过期的天数
    },  // 热门优惠券一个
    trial:{
        id: 1,
        name: '铃木口琴',
        num: 1,   // 试用数量
        applyNum: 12,  // 申请人数
        status: 1,  // 活动状态：  1:...
        finalTime: '2014-10-10 10:11:10',  // 截止时间
        img_540_270: '',
        price: 100,
        score: 10,  // 所需积分
        gold: 10,  // 所需金币
        detail: '',  // 试用详情
     },//最新试用一个
     hotTopics: [
         {//from $topic
           topicId: 2395585,
           title: "有钱你就来",  //标题
           currentPrice: 20.00,  // 现价
           mallName: "京东",  // 电商名称
           price: "五折对低价199",  // 价格描述
           pubDate: 13215412512000,  // 发布时间,时间戳 毫秒
           channelId: 12,  // 计数器栏目id
           imagesForList: ["http://www.a.b/a.png"],
           hasCoupon: 0,  // 是否有优惠券，适用于 优惠，海淘
           cover: "",
           hdCover: "http://www.google.com/1.png",  // 高清图，适用于晒物，经验，试用体验
           ShowPicForApp: 1  // 是否白菜价合集
         },
         ...
     ],//排行榜五个
     getNewCountForApp:{
           newTrialCount: 2  // 新审核通过的试用数量
     }//快捷入口体验中心是否有新试用的红点和数量
  }
}

15.专题列表

getSpecialList

后端接口

专题列表

说明

分页获取专题列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
  status: 0,
  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"
     },
     ...
  ]
}

$special

16.活动列表

listActivity

后端接口

活动列表

说明

分页获取活动列表

提交方式

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,
        appCover: "http://1.c.cn/2.png",  // app活动封面
        title: "亚马逊精选礼品图书满300-100",
        url: "http://www.a.cc/w.do",  // 链点
        urlType: 1   // 爆料终端页   2 外部网页链接
        topicId: 123,  // 爆料id
        seq: 1,  // 排序
        isTop:  1,  // 是否置顶，1 是  0  否
        createAt: 13251245121000
    },
    ...
  ]
}

$activity

17.礼品列表

listGift

后端接口

礼品列表

说明

分页获取礼品列表，传入type为礼品的类型进行查找

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
type	礼品类型： 1 礼品卡 2 实物礼品 3 优惠券	int	1	否
mallId	电商id，0表示查找所有	int	0	否

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  data: [
    {//from $gift
        giftId: 1
        mallName: '京东',  // 电商名称
        imageUrl: "http://a.cn/1.png",  // 图片
        createTime: 13251245124000,  // 创建时间
        disCount: "满400减20",  // 优惠券额度
        expiryDate: 13621321521000,  // 有效期
        remainingDay:2  // 当前时间距离优惠券过期的天数  
    },
    ...
  ]
}

$gift

18.获取电商列表，包含该电商的优惠券数量

listMallWithCouponCount

后端接口

获取电商列表包含该电商的优惠券数量

说明

获取电商列表

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  data: {
    totalCount: 100,
    mallCouponCount: [
        {// from $mallGiftCount
            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"
            count:20
        },
        ...
    ]
  }
}

$mallCouponCount

19.获取试用列表

listActivityList

后端接口

获取试用列表

说明

根据分类获取试用列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
activityTypeId	试用类型id，0表示全部	int	0	是

{
  status: 0,
  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封面"
    }
  ]
}

20.获取试用类型列表

listActivityTypeList

后端接口

获取试用类型列表

说明

获取试用类型列表

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  data: [
    {
      activityTypeId: "类别ID",
      parentId: "父类别ID",
      name: "类别名称"
    }
  ]
}

21.试用详情终端页（Web）

后端接口

试用详情

说明

试用详情终端页

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
activityId	试用id	int	0	是
fontSize	字体大小	int	14	是

内嵌JSON数组的Web，包括点击交互链点

22.判断用户是否已申请

hasApplyForActivity

后端接口

判断用户是否已申请

说明

判断用户是否已经申请

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
activityId	试用id	int	0	是

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

23.申请试用

createApply

后端接口

申请试用

说明

申请试用，需填写姓名（最多输入待定个字符）、手机号码（需为1开头的11位数字）、寄送地址（最多输入待定个字符）、QQ号码（需为5~11位数字）、申请理由（至少输入20个汉字）。申请按钮固定在屏幕底部，不随页面滚动。点击”提交申请“，若各输入项均符合规则，则提示申请已受理并返回试用详情页。点击”提交申请“，若某个输入项不符合规则，则页面显示相应提示。

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
activityId	试用id	long	0	是
name	姓名	String	""	是
telNum	寄送地址	String	""	是
address	试用id	long	0	是
qq	qq号码	int	0	是
reason	申请理由	String	0	是

{
  status: 0,
  msg: "申请成功",
}

24.晒物、经验列表数据接口

getTopicList

后端接口

栏目爆料列表

说明

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

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
sectionId	栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 5 海淘晒物 6 海淘经验 7 试用体验 8 专题	int	0	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  sectionId: 2,
  data: [
      {//from $topic
         topicId: 2395585,
         title: "有钱你就来",  //标题
         topicType: 1  // 0优惠，1海淘，2 发现，3 晒物，4经验
         mallName: "京东",  // 电商名称
         mallId: 1, // 电商id
         price: "五折对低价199",  // 价格描述
         pubDate: "2015-03-10 07:31:47",  // 发布时间,时间戳 毫秒
         overdueStatus: 1,  // 是否过期
         endTime: "2015-03-15 07:31:47",  // 优惠截止时间
         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  // 是否白菜价合集
    },
    …
  ]
}

$topic

25.搜索热词

listHotSearchTerms

后端接口

搜索热词

说明

该推荐词又编辑在聚超值后台设置

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  data: [
    {
      encodeKey: "%E8%85%95%E8%A1%A8",
      key: "腕表"
    },
    {
      encodeKey: "%E6%88%B7%E5%A4%96",
      key: "户外"
    },
    {
      encodeKey: "%E4%B9%90%E9%AB%98",
      key: "乐高"
    },
    {
      encodeKey: "%E6%B4%97%E6%8A%A4%E7%94%A8%E5%93%81",
      key: "洗护用品"
    },
    {
      encodeKey: "%E8%B6%85%E6%9E%81%E6%9C%AC",
      key: "超极本"
    },
    {
      encodeKey: "%E6%89%8B%E6%9C%BA",
      key: "手机"
    }
  ]
}

26.爆料分类

listTopicType

后端接口

获取爆料分类

说明

获取爆料分类使用场景：根据分类等级或父分类id查找所属的分类，一般用于首页或页面头部

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
level	1 一级分类 2 二级分类	int	0	否
parentId	上级分类id	int	0	是

{
  status: 0,
  msg: "请求成功",
  total: 20,
  data: [
    {
      typeId: 1,
      name: "数码家电",
      level: 1
    }
  ]
}

27.搜索接口

listTopicSearch

后端接口

搜索接口

说明

分类搜索返回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: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  data: {
    topics: [
        {//from $topic
           topicId: 2395585,
           title: "有钱你就来",  //标题
           topicType: 1  // 0优惠，1海淘，2 发现，3 晒物，4经验
           mallName: "京东",  // 电商名称
           mallId: 1, // 电商id
           price: "五折对低价199",  // 价格描述
           pubDate: "2015-03-10 07:31:47",  // 发布时间,时间戳 毫秒
           overdueStatus: 1,  // 是否过期
           endTime: "2015-03-15 07:31:47",  // 优惠截止时间
           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  // 是否白菜价合集
        },
        ...
    ],
    searchSectionResults: [
        {// from $sectionExtend
            value: 1,
            name: '海淘',
            count: 12  
        },
        ...
    ]
  }
}

$topic $sectionExtend

28.获取电商列表

listMall

后端接口

获取电商列表

说明

获取电商列表

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  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"
      },
      ...
  ]
}

$mall

29.搜索推荐

searchKeywordHint

后端接口

搜索推荐

说明

根据搜索输入推荐的热门搜索词

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
input	输入内容	String	""	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  data: [
    {
      count: "556",
      key: "iphone 5s"
    },
    ...
  ]
}

30.获取用户资料

getUserInfo

后端接口

获取用户资料

说明

获取用户资料

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  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:求购买家
    
          // img 头像从平台获取
          logo: "http://img.pc.com.cn/1.png",
     }
}

$user

31.获取用户扩展信息

getUserExtend

后端接口

获取用户扩展信息获取试用总数

说明

获取用户扩展信息

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  data: [
    {//from $userExtend and 获取试用总数
      topicNum: 1,
      favNum: 10,
      couponNum: 2    
      trialCount: 2
    }
  ]
}

$userExtend

32.判断是否有新的爆料或者试用

后端接口

获取用户某个时间之后的爆料数和评论数获取新通过的试用数

说明

判断是否有新的爆料或者试用

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
lastAccessTime	最近一次访问该接口的时间	时间戳秒	当前时间	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  data: {
    newTopicCount: 100,
    newCommentCount: 1,
    newSystemNoticeCount: 1,
    newTrialCount: 2
  }
}

$user

33.获取我的爆料

listMyTopic

后端接口

获取我的爆料

说明

用于网友个人中心获取网友的爆料列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
status	爆料审核状态：1 审核通过 2 审核未通过或者待审	int	1	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  data: [
        {//from $topic
            topicId: 2395585,
            title: "有钱你就来",  //标题
            topicType: 1  // 0优惠，1海淘，2 发现，3 晒物，4经验
            mallName: "京东",  // 电商名称
            mallId: 1, // 电商id
            price: "五折对低价199",  // 价格描述
            pubDate: "2015-03-10 07:31:47",  // 发布时间,时间戳 毫秒
            overdueStatus: 1,  // 是否过期
            endTime: "2015-03-15 07:31:47",  // 优惠截止时间
            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  // 是否白菜价合集
        }
        ...
  ]
}

$topic

34.获取收藏列表

listCollects

后端接口

获取收藏列表

说明

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

提交方式

GET

参数

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

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  data: [
      {//from $favorite
        favoriteId: 123,  // 收藏id
        topic: $topic,
        userId: 12,  // 收藏的用户Id
        createAt: 13625123531000
      }
  ]
}

$collect

35.我的试用

listMyApply

后端接口

我的试用

说明

用于网友个人中心获取到已通过，申请中，未通过3中类型的使用申请

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
status	0 申请中 -1未通过 1通过	int	2	是

{
  status: 0,
  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封面"
    }
  ]
}

36.我的优惠券列表

listMyGiftExchange

后端接口

我的优惠券列表

说明

用于网友个人中心获取我的礼品列表，type=3的时候表示优惠券，包括未失效和已失效的

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
status	状态：0 已过期，1 未过期	int	0	是
type	1 礼品卡 2 实物礼品 3 优惠券	int	3	是

{
  status: 0,
  msg: "请求成功",
  pageNo: 1,
  pageSize: 20,
  total: 100,
  data: [
    {//from $giftCoupon
        couponId: 123,  // 优惠券Id
        giftId: 123,  // 礼品Id
        name: "京东卡",
        mallName: '京东',  // 电商名称
        imageUrl: "http://a.cn/1.png",  // 图片
        giftPrice: 12.00,  // 礼品价格
        createTime: 13251245124000,  // 创建时间
        disCount: "满400减20",  // 优惠券额度
        expiryDate: 13621321521000,  // 有效期
        mallId:  12,  // 电商Id
        remainingDay:2  // 当前时间距离优惠券过期的天数
        cardNum: '1232',
        cardPassword: 's123sdssdfs54212',
        status: 1,  // 状态0：禁用；1：未领取；2：已领取
        useDate: 13212457451000,  // 被领取时间
    }
  ]
}

$giftCoupon

37.检查签到状态

checkSignInStatus

后端接口

检查签到状态

说明

检查签到状态

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  msg: "请求成功",
  data: {
    signInStatus: 1,
    days: 12
  }
}

38.签到

signInfForApp

后端接口

签到

说明

app端签到

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  msg: "请求成功",
  data: {
    signInStatus: 1,
    addInt: 10,
    addCoin: 12,
    point: 10,
    gold: 10,
    addPurchasingGold: 10,
    days: 1
  }
}

39.添加爆料

addTopic

后端接口

添加爆料

说明

用于网友个人中心增加爆料功能

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
email	电子邮件	String	""	如果common_session_id为空，则必须输入email
fromUrl	来源	String	""	是
content	用户推荐理由	String	""	是

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

40.设置分类订阅

add_subscription

后端接口

设置分类订阅

说明

设置分类订阅

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
addition	加密后的token	String	""	是
ids	推送分类id	String	""	如果common_session_id为空，则必须输入email
open	是否开启推送： 0 不发送 1 发送	int	1	否
device	设备类型 0 ios 1 android	int	0	是

{
  status: 0,
  msg: "设置成功"
}

41.添加精准订阅

add_subscription_second

后端接口

添加精准订阅

说明

设置分类订阅

提交方式

POST

参数

参数名	参数含义	类型	默认值	是否必须
addition	加密后的token	String	""	是
keyword	关键词	String	""	是
open	是否开启推送： 0 不发送 1 发送	int	1	否
device	设备类型 0 ios 1 android	int	0	是

{
  status: 0,
  msg: "订阅成功"
}

42.获取用户各个频道的收藏数量

countCollects

后端接口

获取用户各个频道的收藏数量

说明

获取收藏列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  msg: "订阅成功",
  data: [
      {//from  $sectionExtend
        value: 1,
        name: '海淘',
        count: 12  
      },
      …
  ]
}

$sectionExtend

43.获得系统和评论通知数量

getSysNoticeAndCommentNum

后端接口

获得系统和评论通知数量

说明

获得系统通知数量和评论数量

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是

{
  status: 0,
  msg: "请求成功",
  data: {
    sentCount: 1,
    receiveCount: 2,
    sysMsgCount: 3
  }
}

44.获得系统通知

listSystemNotice

后端接口

获得系统通知

说明

获得系统通知

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

*注意：该接口返回格式为bip的接口格式，与其他接口不一致。*

{
  pageCount: 15,
  pageNo: 1,
  pageSize: 10,
  total: 2,
  resultList: [
    {
      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
    }
  ]
}

45.我收到的评论

listMyReceiveComment

后端接口

我收到的评论

说明

获得系统通知

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

*注意：该接口返回格式为bip的接口格式，与其他接口不一致。*

{
  pageNo: 1,
  pageSize: 10,
  total: 20,
  pageTotal: 2,
  msg: "请求成功",
  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",
        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: ""看起来不错哦"",  // 被回复的内容
    }
  ]
}

$receiveComment

46.我发出的评论

listMySendComment

后端接口

我发出的评论

说明

获得用户发出的评论列表

提交方式

GET

参数

参数名	参数含义	类型	默认值	是否必须
common_session_id	-	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

*注意：该接口返回格式为bip的接口格式，与其他接口不一致。*

{
  pageNo: 1,
  pageSize: 10,
  total: 20,
  pageTotal: 2,
  msg: "请求成功",
  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",
        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"  // 发表评论者头像
    }
  ]
}

$sendComment

47.领取优惠券

mrobot接口：（mrobot补充）

开发环境url：测试环境url：

接口名：（mrobot接口补充后可删除掉）

exchangeCoupon

后端接口

领取优惠券接口

说明

兑换优惠券接口，是否登录，是否已领完，是否已失效，金币，积分是否不足

提交方式

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 //用户的积分数
    }
}

Download in other formats:

Plain Text

Context Navigation

Table of Contents

聚超值2.0.0接口文档

一.基本约定

二.接口列表

1.首页列表数据接口

2.优惠、海淘、发现、试用体验、专题列表数据接口

3.获取用户某个时间之后的爆料数和评论数

4.单篇爆料、晒物、经验、体验报告、专题终端页（Web）

5.判断用户是否已收藏爆料

6.收藏

7.取消收藏

8.获取爆料赞和踩的数量

9.赞或者踩

10.爆料正文中图片集列表

11.代购商家列表

12.求代购

13.优惠券终端页（Web）

14.广场数据接口

15.专题列表

16.活动列表

17.礼品列表

18.获取电商列表，包含该电商的优惠券数量

19.获取试用列表

20.获取试用类型列表

21.试用详情终端页（Web）

22.判断用户是否已申请

23.申请试用

24.晒物、经验列表数据接口

25.搜索热词

26.爆料分类

27.搜索接口

28.获取电商列表

29.搜索推荐

30.获取用户资料

31.获取用户扩展信息

32.判断是否有新的爆料或者试用

33.获取我的爆料

34.获取收藏列表

35.我的试用

36.我的优惠券列表

37.检查签到状态

38.签到

39.添加爆料

40.设置分类订阅

41.添加精准订阅

42.获取用户各个频道的收藏数量

43.获得系统和评论通知数量

44.获得系统通知

45.我收到的评论

46.我发出的评论

47.领取优惠券

Download in other formats: