Changes between Version 30 and Version 31 of price_api


Ignore:
Timestamp:
03/12/2015 09:41:56 AM (11 years ago)
Author:
oujianqiang
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • price_api

    v30 v31  
    33= 聚超值2.0.0接口文档 =  
    44 
     5== 一.基本约定 == 
     6 
     7{{{ 
     8  1.开发机、测试机代理地址： 
     9  mrobot开发机代理：192.168.10.199  端口：1080 
     10  mrobot测试机代理：192.168.10.198  端口：1080 
     11   
     12  2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     13   
     14  3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 
     15      { 
     16         "desc":"给用户的提示放在这里" 
     17      } 
     18       
     19  4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 
     20   
     21  5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     22   
     23  6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 
     24   
     25  7.需要分页的接口，统一返回以下字段:  pageNo,pageSize,total 
     26}}} 
     27 
     28 
     29== 二.接口列表 == 
     30 
    531== 1.首页列表数据接口 ==  
    6  
    7 > index 
     32**mrobot接口**：（代补充） 
     33> 开发环境url： 
     34> 测试环境url： 
     35 
     36**接口名**：（mrobot接口补充后 可删除掉） 
     37> homepageList 
    838 
    939**后端接口** 
    … …  
    2959{{{#!java 
    3060{ 
    31     "pageNo": 1, 
    32     "pageSize": 20, 
    33     "pageTotal": 2168, 
    34     "total": 43357 
    35     "serverTime": 1426036331, 
    36     "focus": [//焦点图 
     61    status: 0,  
     62    msg: "请求成功", 
     63    pageNo: 1, 
     64    pageSize: 20, 
     65    pageTotal: 2168, 
     66    total: 43357 
     67    serverTime: 1426036331, 
     68    focus: [//焦点图 
    3769        {//from $focusImage 
    3870            "topicId": 125,  // 爆料id 
    … …  
    4375        ... 
    4476    ] 
    45     "listIndex":[ 
     77    listIndex:[ 
    4678        { 
    4779            type:1 // 1 爆料 
    … …  
    6799            type:2 // 2 推荐位 
    68100            value:{//from $adPosition 
    69                     "adId": 51, 
    70                     "adTitle": "好东西哇", 
    71                     "price": "12块包邮", 
    72                     "image": "http://img.pconline.com.cn/7.jp", 
    73                     "topicId": 23412 
    74                     "seq":3  // 排序，插入到首页的位置 
     101                    adId: 51, 
     102                    adTitle: "好东西哇", 
     103                    price: "12块包邮", 
     104                    image: "http://img.pconline.com.cn/7.jp", 
     105                    topicId: 23412 
     106                    seq:3  // 排序，插入到首页的位置 
    75107            } 
    76108        } 
    … …  
    78110            type:4 // 4 优惠券 
    79111            value:{//from $giftCoupon 
    80                 "couponId": 123,  // 优惠券Id 
    81                 "giftId": 123,  // 礼品Id 
    82                 "mallName": '京东',  // 电商名称 
    83                 "image": "http://a.cn/1.png",  // 图片 
    84                 "disCount": "满400减20",  // 优惠券额度 
    85                 "status": 1,  // 状态0：禁用；1：未领取；2：已领取 
    86                 "expiryDate": 13621321521000,  // 有效期 
     112                couponId: 123,  // 优惠券Id 
     113                giftId: 123,  // 礼品Id 
     114                mallName: '京东',  // 电商名称 
     115                image: "http://a.cn/1.png",  // 图片 
     116                disCount: "满400减20",  // 优惠券额度 
     117                status: 1,  // 状态0：禁用；1：未领取；2：已领取 
     118                expiryDate: 13621321521000,  // 有效期 
    87119            } 
    88120        } 
    … …  
    92124}}} 
    93125 
    94 [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#优惠券 $giftCoupon]  
     126[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#优惠券 $giftCoupon]  
    95127 
    96128---------- 
    97129 
    98130== 2.优惠、海淘、发现、试用体验、专题列表数据接口 ==  
    99  
    100 > getTopicList 
     131**mrobot接口**：（代补充） 
     132> 开发环境url： 
     133> 测试环境url： 
     134 
     135**接口名**：（mrobot接口补充后 可删除掉） 
     136> topicList 
    101137 
    102138**后端接口** 
    … …  
    123159{{{#!java 
    124160{ 
    125     "pageNo": 1, 
    126     "pageSize": 20, 
    127     "pageTotal": 2168, 
    128     "total": 43357 
    129     "serverTime": 1426036331, 
    130     "data":[ 
     161    status: 0,  
     162    msg: "请求成功", 
     163    pageNo: 1, 
     164    pageSize: 20, 
     165    pageTotal: 2168, 
     166    total: 43357 
     167    serverTime: 1426036331, 
     168    data:[ 
    131169        {//from $topic 
    132170            topicId: 2395585, 
    … …  
    156194 
    157195== 3.获取用户某个时间之后的爆料数和评论数 ==  
    158  
    159 > getNewCountForApp 
     196**mrobot接口**：（代补充） 
     197> 开发环境url： 
     198> 测试环境url： 
     199 
     200**接口名**：（mrobot接口补充后 可删除掉） 
     201> getNewsCount 
    160202 
    161203**后端接口** 
    … …  
    194236 
    195237== 4.单篇爆料、晒物、经验、体验报告、专题终端页（Web） ==  
    196  
    197 >  
     238**mrobot接口**：（代补充） 
     239> 开发环境url： 
     240> 测试环境url： 
     241 
     242**接口名**：（mrobot接口补充后 可删除掉） 
     243> topicDetail 
    198244 
    199245**后端接口** 
    … …  
    217263 
    218264**返回** 
    219  
    220 {{{#!java 
    221 内嵌JSON数组的Web，包括点击交互链点 
     265   
     266{{{#!java 
     267  web页面的html代码，内嵌JSON格式的附加信息，以及点击交互的跳转协议 
     268  附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾 
     269 
     270  >>>>>>>>>>附加信息: 
     271  { 
     272    bestBuyLink:"bestbuy://topic-1.cc"  // 直达链接，可能是自定义的协议或者普通的url 
     273  } 
     274  <<<<<<<<<< 
     275 
     276  >>>>>>>>>>跳转协议： 
     277  ---跳转进入优惠券详情 点击爆料详情终端页的"优惠券"内时触发 
     278  pconlinebestbuy://bestbuy-giftCoupon-detail/giftId={giftId} 
     279  跳转参数说明： 
     280  giftId：礼品id 
     281 
     282  ---跳转浏览大图 点击爆料详情终端页的任一张图片时触发 
     283  pconlinebestbuy://bestbuy-show-photo?topicId={topicId}&currentIndex={currentIndex} 
     284  跳转参数说明： 
     285  topicId：爆料id 
     286  currentIndex：图片序号 
     287 
     288  ---跳转进入商家列表 点击爆料详情终端页的"有**家商家可代购"时触发 
     289  pconlinebestbuy://bestbuy-purchasing-list?topicId={topicId} 
     290  跳转参数说明： 
     291  topicId：爆料id 
     292 
     293  ---跳转进入商家淘宝商品页 点击爆料详情终端页底部的"推挤代购商家"时触发 
     294  pconlinebestbuy://bestbuy-purchasing-dg-terminal?link={link} 
     295  跳转参数说明： 
     296  link：代购地址 
     297  <<<<<<<<<< 
    222298}}} 
    223299 
    … …  
    225301 
    226302== 5.判断用户是否已收藏爆料 ==  
    227  
    228 > getTopicCollectCount 
     303**mrobot接口**：（代补充） 
     304> 开发环境url： 
     305> 测试环境url： 
     306 
     307**接口名**：（mrobot接口补充后 可删除掉） 
     308> checkTopicCollectStatus 
    229309 
    230310**后端接口** 
    … …  
    252332  status: 0, 
    253333  msg: "请求成功", 
    254   hasCollect: 0 
     334  hasCollect: 0// 0 表示未收藏   1 表示已收藏 
    255335} 
    256336}}} 
    … …  
    259339 
    260340== 6.收藏 ==  
    261  
    262 > collectForApp 
     341**mrobot接口**：（代补充） 
     342> 开发环境url： 
     343> 测试环境url： 
     344 
     345**接口名**：（mrobot接口补充后 可删除掉） 
     346> collectOneTopic 
    263347 
    264348**后端接口** 
    … …  
    292376 
    293377== 7.取消收藏 ==  
    294  
    295 > decollectForApp 
     378**mrobot接口**：（代补充） 
     379> 开发环境url： 
     380> 测试环境url： 
     381 
     382**接口名**：（mrobot接口补充后 可删除掉） 
     383> decollectOneTopic 
    296384 
    297385**后端接口** 
    … …  
    325413 
    326414== 8.获取爆料赞和踩的数量 ==  
    327  
     415**mrobot接口**：（代补充） 
     416> 开发环境url： 
     417> 测试环境url： 
     418 
     419**接口名**：（mrobot接口补充后 可删除掉） 
    328420> getTopicLikeAndDislikeCount 
    329421 
    … …  
    362454 
    363455== 9.赞或者踩 ==  
    364  
     456**mrobot接口**：（代补充） 
     457> 开发环境url： 
     458> 测试环境url： 
     459 
     460**接口名**：（mrobot接口补充后 可删除掉） 
    365461> likeAndDislike 
    366462 
    … …  
    395491 
    396492== 10.爆料正文中图片集列表 ==  
    397  
    398 > listTopicImages 
     493**mrobot接口**：（代补充） 
     494> 开发环境url： 
     495> 测试环境url： 
     496 
     497**接口名**：（mrobot接口补充后 可删除掉） 
     498> topicImagesList 
    399499 
    400500**后端接口** 
    … …  
    424524  data: [ 
    425525    { 
    426       index: 1, 
    427       url: "http://img/pc.com.cn/1.png" 
     526      url: "http://img/pc.com.cn/1.png", 
     527      url: "http://img/pc.com.cn/2.png", 
     528      ... 
    428529    } 
    429530  ] 
    … …  
    434535 
    435536== 11.代购商家列表 ==  
    436  
    437 > listpurchasing 
     537**mrobot接口**：（代补充） 
     538> 开发环境url： 
     539> 测试环境url： 
     540 
     541**接口名**：（mrobot接口补充后 可删除掉） 
     542> purchasingList 
    438543 
    439544**后端接口** 
    … …  
    463568  msg: "请求成功", 
    464569  total: 100, 
    465   data: ["$purchasing"] 
     570  data: {//from $purchasing 
     571      description: "超值代购",  //代购商家描述 
     572      hasSpotGoods: 1,  // 是否有现货：0 现货/1 代购 
     573      link: "http://www.taobao.com/item_1.html"  //代购地址   
     574      name: "Jason",  //用户名 
     575      nickName: "Jason",  //昵称 
     576      logo: "http://img.pc.com.cn/1.png",  //头像 从平台获取 
     577      price: 128,  //价格  
     578  } 
    466579} 
    467580}}} 
    468581 
    469582[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#代购商家 $purchasing] 
     583[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#代购商家 $user] 
    470584 
    471585---------- 
    472586 
    473587== 12.求代购 ==  
    474  
     588**mrobot接口**：（代补充） 
     589> 开发环境url： 
     590> 测试环境url： 
     591 
     592**接口名**：（mrobot接口补充后 可删除掉） 
    475593> addTopicBuyCount 
    476594 
    … …  
    508626 
    509627== 13.优惠券终端页（Web） ==  
    510  
    511 > getGiftInfo 
     628**mrobot接口**：（代补充） 
     629> 开发环境url： 
     630> 测试环境url： 
     631 
     632**接口名**：（mrobot接口补充后 可删除掉） 
     633> giftDetail 
    512634 
    513635**后端接口** 
    … …  
    532654 
    533655{{{#!java 
    534 内嵌JSON数组的Web，包括点击交互链点 
     656  web页面的html代码，内嵌JSON格式的附加信息，以及点击交互的跳转协议 
     657  附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾 
     658 
     659  >>>>>>>>>>附加信息: 
     660  { 
     661      （暂无） 
     662  } 
     663  <<<<<<<<<< 
     664 
     665  >>>>>>>>>>跳转协议： 
     666  ---领取优惠券 
     667  pconlinebestbuy://bestbuy-get-giftCoupon/giftId={giftId}&giftName={giftName}&needScore={needScore}&needGold={needGold} 
     668  跳转参数说明： 
     669  giftId：礼品id 
     670  giftName：优惠券概要信息 
     671  needScore：兑换所需积分 
     672  needGold：兑换多需金币 
     673  <<<<<<<<<< 
    535674}}} 
    536675 
    … …  
    21732312 
    21742313== 47.领取优惠券 ==  
    2175  
     2314**mrobot接口**：（代补充） 
     2315> 开发环境url： 
     2316> 测试环境url： 
     2317 
     2318**接口名**：（mrobot接口补充后 可删除掉） 
    21762319> exchangeCoupon 
    21772320 
    … …  
    22002343    status: 1 
    22012344    msg: '兑换成功' 
    2202 } 
    2203 }}} 
    2204  
    2205 ---------- 
     2345    data: { 
     2346        status:1,  // 1 兑换成功  -1  请刷新页面重试  -2 该优惠券无效   -3 该优惠券已过期  -4 兑换出错，请稍后再试。 -5 优惠券领取次数超过限制!  -6 金币或积分不足!  -7 该优惠券无效或已全部被兑换!  -8 兑换失败！ 
     2347        cardNum: 123, //券号 
     2348        giftStatus: 1, 
     2349        cardPassword: 123456, //密码 
     2350        mallUrl: "http://a.b.c", //商品wap主页 
     2351        gold:1, //用户的金币数 
     2352        score: 2 //用户的积分数 
     2353    } 
     2354} 
     2355}}} 
     2356 
     2357----------