Changes between Initial Version and Version 1 of pconline_3.9.0/interface


Ignore:
Timestamp:
07/18/2014 03:19:43 PM (12 years ago)
Author:
tianjie
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pconline_3.9.0/interface

    v1 v1  
     1== 1.基本约定 == 
     2{{{ 
     3接口通用参数 
     4req_enc=utf-8(必须放url后面) 
     5resp_enc=utf-8(必须放url后面) 
     6common_session_id=xxxx(以cookies中的优先) 
     7 
     8接口URL: 接口URL 
     9必填参数:参数名=xxx(多种情况用括号解析) 
     10非必填参数:参数名=xxx(多种情况用括号解析) 
     11说明文档参数:添加某特定参数可以直接看接口文档 
     12是否需要登录:是,否 
     13返回格式:json,ssi,xml 
     14缓存方式:接口缓存,对象缓存 
     15缓存时间:缓存时间 
     16返回结果:结果可能情况 
     17}}} 
     18 
     19== 2.接口列表 == 
     20=== 2.1 [=#point201 添加文章收藏] === 
     21{{{ 
     22备注:此接口添加文章收藏到已登录用户中;直播文章无收藏功能 
     23mrobot url:暂无 
     24Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=addArtCollect&siteId=1&articleId=5105797&callback=(Web端收藏文章) 
     25HTTP请求方式:get 
     26是否需要登录:是 
     27返回格式:json 
     28缓存方式:无 
     29缓存时间:无 
     30请求参数: 
     31    act:请求动作,addArtCollect为添加收藏 
     32    siteId:主网站id,电脑网为1 
     33    articleId:文章id 
     34    callback:回调方法,Web端通过jsonp方式传递回调方法,客户端不使用该参数 
     351、正常返回 
     36{ 
     37    "code":0, 
     38    "message":"31356890用户收藏文章成功!" 
     39} 
     402、异常返回 
     41{ 
     42    "code":1, 
     43    "message":"该文章已被该用户收藏" 
     44} 
     45}}} 
     46 
     47=== 2.2 [=#point202 取消文章收藏] === 
     48{{{ 
     49备注:此接口取消已登录用户的文章收藏;直播文章无收藏功能 
     50mrobot url:暂无 
     51Web端 url:http://my.pconline.com.cn/bip/intf/article.jsp?act=delMyCollection&siteId=1&articleId=5105797(Web端取消收藏文章) 
     52HTTP请求方式:get 
     53是否需要登录:是 
     54返回格式:json 
     55缓存方式:无 
     56缓存时间:无 
     57请求参数: 
     58    act:请求动作,delMyCollection为取消收藏 
     59    siteId:主网站id,电脑网为1 
     60    articleId:文章id 
     611、正常返回 
     62{ 
     63    "code":0, 
     64    "message":"删除收藏文章成功!" 
     65} 
     66}}} 
     67 
     68=== 2.3 [=#point203 已收藏文章列表] === 
     69{{{ 
     70备注:此接口返回已登录用户已收藏的文章列表 
     71mrobot url:http://mrobot.pconline.com.cn/v3/itbbs/collectionDownload/31356890?pageSize=20&pageNo=1 
     72Web端 url:http://my.pconline.com.cn/collection/myArticle.jsp(Web端个人中心获取已收藏文章列表) 
     73HTTP请求方式:get 
     74是否需要登录:是 
     75返回格式:json 
     76缓存方式:无 
     77缓存时间:无 
     78请求参数: 
     79    pageNo:当前请求页码 
     80    pageSize:每页返回条数 
     81返回参数说明: 
     82原接口数据保持不变,增加已收藏文章的返回信息 
     83    articleCount:已收藏文章数量 
     84    articlePageCount:已收藏文章的页数,根据articleCount和pageSize计算得到 
     85    articleList:根据pageNo和pageSize返回的已收藏文章列表 
     86文章列表字段: 
     87    id:收藏id 
     88    name:文章标题 
     89    articleId:文章id 
     90    imageUrl:文章的配图,若该文章没有图片,则为空 
     91返回结果: 
     92{ 
     93    "forumCount": 11, 
     94    "forumList": [{ 
     95        "forumId": 668543, 
     96        "id": 2903021, 
     97        "name": "iPhone综合讨论区" 
     98    }, { 
     99        "forumId": 769246, 
     100        "id": 2891611, 
     101        "name": "我要踢爆" 
     102    }], 
     103    "forumPageCount": 1, 
     104    "pieForumCount": 2, 
     105    "pieForumList": [{ 
     106        "forumId": 76, 
     107        "id": 15438, 
     108        "name": "最吹水肥皂区" 
     109    }, { 
     110        "forumId": 48, 
     111        "id": 14400, 
     112        "name": "最数码二手闲置交易" 
     113    }], 
     114    "pieForumPageCount": 1, 
     115    "pieTopicCount": 4, 
     116    "pieTopicList": [{ 
     117        "id": 15663, 
     118        "name": "从机械胶卷到数码CMOS,十年单反路--最后还有重武器“出仓”", 
     119        "topicId": 76565 
     120    }, { 
     121        "id": 15662, 
     122        "name": "好屌的自行车", 
     123        "topicId": 102316 
     124    }], 
     125    "pieTopicPageCount": 1, 
     126    "topicCount": 33, 
     127    "topicList": [{ 
     128        "id": 2904262, 
     129        "name": "那些年,80后一起用过的电脑", 
     130        "topicId": 51599565 
     131    }, { 
     132        "id": 2869645, 
     133        "name": "各位高手能帮我看看这是什么牌子的电源吗", 
     134        "topicId": 51445926 
     135    }], 
     136    "topicPageCount": 2, 
     137    "articleCount": 2, 
     138    "articleList": [{ 
     139        "id": 2904262, 
     140        "name": "500万画点!西铁城推出超高分辨率EVF", 
     141        "articleId": 5045678, 
     142        "imageUrl": "http://img0.pconline.com.cn/pconline/1407/04/5045678_1_thumb.jpg" 
     143    }, { 
     144        "id": 2869645, 
     145        "name": "免费WIFI无限畅玩 荣耀6专属WLAN初体验", 
     146        "articleId": 5027277, 
     147        "imageUrl": "http://img0.pconline.com.cn/pconline/1407/01/5027277_100.jpg" 
     148    }], 
     149    "articlePageCount": 1, 
     150    "pageCount": 2, 
     151    "pageNo": 1, 
     152    "pageSize": 20, 
     153    "total": 52 
     154} 
     155}}} 
     156 
     157=== 2.4 [=#point204 文章顶、踩接口] === 
     158{{{ 
     159备注:此接口对该文章进行顶、踩操作;直播文章无顶踩功能 
     160mrobot url:暂无 
     161Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=addArtAgree&siteId=1&articleId=5105797&isAgree=1&callback=(Web端顶、踩文章) 
     162HTTP请求方式:get 
     163是否需要登录:否 
     164返回格式:json 
     165缓存方式:无 
     166缓存时间:无 
     167请求参数: 
     168    act:请求动作,addArtAgree为顶文章 
     169    siteId:主网站id,电脑网为1 
     170    articleId:文章id 
     171    isAgree:顶或踩:1表示顶;2表示踩 
     172    callback:回调方法,Web端通过jsonp方式传递回调方法,客户端不使用该参数 
     1731、顶、踩文章正常返回 
     174{ 
     175    "code":0, 
     176    "message":"用户赞、踩文章成功" 
     177} 
     1782.1、已顶过的文章再进行顶踩操作返回 
     179{ 
     180    "code":1, 
     181    "message":"该文章已被该用户赞过" 
     182} 
     1832.2、已踩过的文章再进行顶踩操作返回 
     184{ 
     185    "code":2, 
     186    "message":"该文章已被该用户踩过" 
     187} 
     188}}} 
     189 
     190=== 2.5 [=#point205 获取文章顶踩数据接口] === 
     191{{{ 
     192备注:此接口获取文章顶踩数据;直播文章无改功能 
     193mrobot url:暂无 
     194Web端 url:http://bip.pconline.com.cn/intf/article.jsp?act=getArticleCount&siteId=1&articleId=5105797&additionalCollect=0&additionalAgree=0&additionalAgainst=0(Web端获取文章顶踩数据) 
     195HTTP请求方式:get 
     196是否需要登录:否 
     197返回格式:json 
     198缓存方式:无 
     199缓存时间:无 
     200请求参数: 
     201    act:请求动作,getArticleCount为获取文章顶踩数据 
     202    siteId:主网站id,电脑网为1 
     203    articleId:文章id 
     204    additionalCollect:请与Web接口同事沟通 
     205    additionalAgree:请与Web接口同事沟通 
     206    additionalAgainst:请与Web接口同事沟通 
     2071、正常返回 
     208{ 
     209    "id":848544, 
     210    "createTime":1405479564000, 
     211    "siteId":1, 
     212    "articleId":5105797, 
     213    "collectCount":0, 
     214    "addCollect":0, 
     215    "agreeCount":6, 
     216    "addAgree":0, 
     217    "againstCount":0, 
     218    "addAgainst":0 
     219} 
     220}}}