[[TOC]]

= 聚超值2.3.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
  
  8.wap页的附加信息（JSON格式），用注释的方式放到html代码里，以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾

}}}


== 二.接口列表 ==


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

**需求：**[[BR]]

{{{
请求参数的变动：新增3个参数
1）platform：平台，传”iOS”或”Android”；
2）v：app版本号，如2.3.0；
3）inReview=1（Android不传）；

返回参数的变动：
如果是来自iOS的请求，则在Topic类型的实体，新增2个字段：
1、爆料简介；
2、爆料正文（正文不带图片，不带html标签，字数较多[标准由产品定]则截取）；
}}}

**mrobot接口**
> http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp  [[BR]]
eg: http://mrobot.pconline.com.cn/s-300/best/cms/listHomepage.xsp?pageNo=1&pageSize=10&v=2.3.0&platform=iOS&inReview=0 [[BR]]

**后端接口**
> 首页精选数据接口：http://best.pconline.com.cn/app/facade/cache/index.do?pageNo=1&pageSize=20 [[BR]]
> 焦点图：http://best.pconline.com.cn/app/focus/cache/listFocus.do?topicTypeId=0&type=0&v=2.3.0&platform=iOS&inReview=0 [[BR]]

**后端接口文档**

> [http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/facade 首页数据接口] [http://rdtrac.pc.com.cn/pc_best/wiki/app2.0/11_focusImage 焦点图]
**说明**

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

**缓存时间**

> 300s

**提交方式**

> GET

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||
||v||版本号||int||0||否||

**返回格式**
> json

**返回**

{{{#!java
{
    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  // 当前时间距离优惠券过期的天数
               
            }
        }
        ...
    ]
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#焦点图 $focusImage] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料 $topic] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#推荐位 $adPosition] [http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼品 $gift] 

----------


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

**需求：**[[BR]]

{{{
请求参数的变动：
1、sectionId参数新增1个取值：
1）sectionId=100[后端已提供]时，请求属于“一键购”的海淘列表数据。

2、新增3个筛选条件的参数：
1）电商商城；
2）当前热点；
3）精彩推荐；

3、新增3个用于控制的参数：
1）platform：平台，传”iOS”或”Android”；
2）v：app版本号，如2.3.0；
3）inReview=1（Android不传）；


返回参数的变动：
如果是来自iOS的请求，则在Topic类型的实体，新增2个字段：
1、爆料简介；
2、爆料正文（正文不带图片，不带html标签，字数较多[标准由产品定]则截取）；


修改图片点击的协议：新增一个参数：
1、图片链接imgUrl

具体协议为：
pconlinebestbuy://best-big-photo/{topicId}?curIndex={curIndex}&imgUrl={imgUrl}
跳转参数说明：
topicId：爆料id
curIndex：所点击图片的序号（从0算起）
imgUrl：所点击图片的地址链接，其中特殊字符需要url编码
}}}


**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.3.0&platform=iOS&inReview=0 [[BR]]

**后端接口**

> 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 [[BR]]

**后端接口文档**

> [http://trac.pc.com.cn/pc_best/wiki/app2.0/01_topic#栏目爆料列表 栏目爆料列表]

**说明**

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

**缓存时间**

> 300s

**提交方式**

> GET

**是否需要登录**

> 否

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =||
||sectionId||栏目id：0 优惠 1 海淘 2 发现 3 晒物 4 经验 ||int||0||是||||
||pageNo||页数||int||1||是||||
||pageSize||页面大小||int||10||是||||
||v||版本号||int||0||否||2.3.0版本传v=2.3.0||
||inReview||审核状态||int||0||否||1-是，0-不是||

**返回格式**
> json

**返回数据**

{{{#!java
{
  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需求:新增字段】
        }
        ...
    ]
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料 $topic]

----------


=== 1.3 发现列表的筛选条件（M） ===

**需求：**[[BR]]
新接口[[BR]]

**mrobot接口**

> 待补充

**后端接口**

> 待补充

**后端接口文档**

> 待补充

**说明**

> 返回用于发现类爆料的筛选条件

**缓存时间**

> 无

**提交方式**

> GET

**是否需要登录**

> 否

**参数**（待定）

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =||
||v||版本号||int||0||否||2.3.0版本传v=2.3.0||

**返回格式**
> json

**返回数据**

> 


----------

=== 1.4 搜索接口（M） === 


**需求：**[[BR]]
{{{
请求参数的变动：新增3个参数
1）platform：平台，传”iOS”或”Android”；
2）v：app版本号，如2.3.0；
3）inReview=1（Android不传）；

返回参数：
如果是来自iOS的请求，则在Topic类型的实体，新增2个字段：
1、爆料简介；
2、爆料正文（正文不带图片，不带html标签，字数较多[标准由产品定]则截取）；
}}}



**mrobot接口**：
>http://mrobot.pconline.com.cn/s-300/best/search/listTopicSearch.xsp

**后端接口**

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

**后端接口文档**

> [http://trac.pc.com.cn/pc_best/wiki/app2.0/02_search#搜索接口 搜索接口][[BR]]

**说明**

> 分类搜索返回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

**返回**

{{{#!java
{
  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  
        },
        ...
    ]
  }
}
}}}
[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#爆料 $topic]
[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#栏目搜索结果 $sectionExtend]

----------


=== 1.5 爆料详情终端页（M） ===

**需求：**[[BR]]

{{{
返回数据的变动：
1、【优惠】、【海淘】2类的爆料终端页正文内容：
1）新增“可能喜欢”的爆料入口，并加上跳转协议；
2）新增“内容标签”，加上点击协议；
3）新增该爆料相关的优惠券页面入口按钮，加上点击协议；

2、【发现】类的爆料终端页正文内容：
1）新增“可能喜欢”的爆料入口，并加上跳转协议

3、【晒物】、【经验】2类的爆料终端页正文内容：
1）新增内容标签，加上点击协议；

}}}


**mrobot接口**

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

**后端接口**

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

**后端接口文档**

> [http://trac.pc.com.cn/pc_best/wiki/app2.0/01_topic#爆料详细信息 爆料详细信息]
> [http://rdtrac.pc.com.cn/cmt/wiki/intf 读取评论总数]
**说明**

> 爆料详情终端页

**缓存时间**

> 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格式的附加信息，以及点击交互的跳转协议[[BR]]
附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾[[BR]]

附加信息：
||= 爆料类型 =||= 附加信息内容 =||
||优惠、海淘、发现||#见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需求:新增字段】
}
}}}

跳转协议：[[BR]]
优惠/海淘/发现 详情终端页:[[BR]]
正文字号的问题，跟前端和设计确认了，设计稿的尺寸到制作稿时要减半，所以正文的大中小字号应该分别为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）||
[[BR]]
晒物详情终端页:[[BR]]
||=协议=||=参数说明=||=触发事件=||
||pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex}||topicId：爆料id；curIndex：图片序号||点击爆料详情终端页的任一张图片时触发，浏览大图 ||
||pconlinebestbuy://best-outer-web/?url={url}||url：代购地址||点击爆料详情终端页底部的"推荐代购商家"时触发，进入商家淘宝商品外链||

经验详情终端页:[[BR]]
||=协议=||=参数说明=||=触发事件=||
||pconlinebestbuy://best-big-photo/topicId?curIndex={curIndex}||topicId：爆料id；curIndex：图片序号||点击爆料详情终端页的任一张图片时触发，浏览大图 ||


[[BR]]
晒物及经验详情页面，头图采用hdCover,按hd=0则取hdCover的400x200尺寸,hd=1则取hdCover的600x300尺寸

----------


=== 1.6 爆料关联的优惠券（M） ===

**需求：**[[BR]]
新接口[[BR]]

**mrobot接口**

> 待补充

**后端接口**

> 待补充

**后端接口文档**

> 待补充

**说明**

> 返回该篇爆料关联的优惠券信息

**缓存时间**

> 无

**提交方式**

> GET

**是否需要登录**

> 否

**参数**（待定）

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =||
||v||版本号||int||0||否||2.3.0版本传v=2.3.0||

**返回格式**
> json

**返回数据**

> 


----------

=== 1.7 优惠券终端页（M） ===

**需求：**[[BR]]
补充正文内容：领取优惠券花费的钻石数。

**mrobot接口**：
>http://mrobot.pconline.com.cn/s/best/gift/giftDetail.xsp

**后端接口**

> http://best.pconline.com.cn/app/gift/getGiftInfo.do

**后端接口文档**

> [http://trac.pc.com.cn/pc_best/wiki/app2.0/05_gift#优惠券信息 优惠券信息][[BR]]

**说明**

> 优惠券终端页

**缓存时间**

> 无

**提交方式**

> GET

**参数**

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

**返回格式**
> html

**返回数据**
> html页面

{{{#!java
  html页面附加信息:
  {
    giftId: 1,  // 礼品id
    stockNum: 12,  // 剩余库存
    expiryDate: 13621321521000,  // 有效期
    remainingDay:2  // 当前时间距离优惠券过期的天数
  }
}}}

----------

=== 1.8 领取优惠券 === 

**需求：**[[BR]]

{{{
返回数据变动：
1、新增1个字段：钻石数；
2、data中的status新增因钻石数不足的情况；
}}}


**后端接口**
>正式：http://best.pconline.com.cn/app/my/gift/exchangeCoupon.do [[BR]]
>测试：http://v42.pconline.com.cn/app/my/gift/exchangeCoupon.do [[BR]]
>开发：http://dev34.pconline.com.cn:81/app/my/gift/exchangeCoupon.do

**后端接口文档**

> [http://trac.pc.com.cn/pc_best/wiki/app2.0/05_gift#领取优惠券接口 领取优惠券接口]

**说明**

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

**缓存时间**

> 无

**提交方式**

> POST

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||common_session_id||-||String||""||是||
||giftId||礼品Id，注意这里传入礼品的giftId而不是优惠券的couponId||int||1||是||

**返回格式**
> json

**返回数据**

{{{#!java
{
    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 跳转协议 ==

{{{

聚超值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}&imgUrl={imgUrl}
跳转参数说明：
topicId：爆料id
curIndex：所点击图片的序号（从0算起）
imgUrl：所点击图片的地址链接


操作协议——————————————————————
---关闭页面
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}&sectionId={sectionId}
参数说明：
searchType：搜索类型。1 按分类搜索, 2 按电商搜索, 3 按标签搜索, 4 按关键词搜索
searchCondition：搜索条件。1(分类id), 2(电商名称),3(标签名称),4（关键词）
sectionId：默认选择的列表类型。 0优惠，1海淘，2 发现，3 晒物，4经验

--- 查看 爆料相关优惠券
pcaction://show-topic-coupons?topicId={topicId}
参数说明：
topicId：爆料id


}}}