Changes between Version 1 and Version 2 of baby2.7_developers/interface


Ignore:
Timestamp:
10/19/2015 06:22:59 PM (10 years ago)
Author:
zengwenjie
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • baby2.7_developers/interface

    v1 v2  
    1 [[TOC]] 
    2  
    3 = 亲子宝典2.6.0接口文档 = 
    4 >mrobot代理环境说明:  
    5   192.168.10.198:1080(192.168.74.80)[[BR]]  
    6   192.168.10.199:1080 ,连的是dev40的开发环境(192.168.75.40)[[BR]]  
    7  
    8 ---------- 
    9  
    10 == 4.私密圈 == 
    11 ---------- 
    12 === 4.1私语列表 === 
    13 '''(mrobot已完成开发,请连开发机进行测试)'''[[BR]] 
    14 mrobot接口:http://mrobot.pcbaby.com.cn/s/qzbd/bbs/getSecretTopics.xsp [[BR]] 
    15 后端接口:http://bbs.pcbaby.com.cn/mobile/v2_2/getSecretTopics.do  
    16  
    17 **说明** 
    18  
    19 > 新增置顶的活动专区,活动帖个数最多两个,返回数据需要新增一个数组返回活动帖 [[BR]] 
    20  
    21 **缓存时间** 
    22  
    23 >无 
    24  
    25 **提交方式** 
    26  
    27 > GET 
    28  
    29 **是否登录** 
    30  
    31 > 否 
    32  
    33 **数据来源** 
    34  
    35 >论坛后台 
    36  
    37 **参数** 
    38  
    39 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=|| 
    40 ||type||列表类型||string|| ||是||1=私语,2=话题|| 
    41 ||pageNo||页码||string|| || ||页码|| 
    42 ||pageSize||每页条数||string|| || ||每页条数|| 
    43 ||maxLength||内容最大长度||string||240 || || || 
    44 ||agent||app类型||string|| || ||2=亲子宝典IOS端,3=亲子宝典Android端|| 
    45 ||v||app版本号||string|| || ||版本号,v=260|| 
    46 **返回** 
    47  
    48 {{{#!java 
    49 { 
    50   pageNo: 1,    //当前页码 
    51   pageSize: 20, //每页条数,这里具体是指topics的个数,不包括activitys的 
    52   total: 15163, //总数量 
    53   activitys://活动帖,最多两个 
    54   [  
    55    {  
    56      topicId: 2156386,          //帖子ID 
    57       title: "最难忘前任的那点",    //标题 
    58     } 
    59    ], 
    60   topics: [ 
    61     {  
    62       topicId: 2156386,          //帖子ID 
    63       title: "最难忘前任的那点",    //标题 
    64       message: "最难忘前任的那点", //帖子内容(当recommend=1且recommendType=3时,这里为“引导话题贴内容”) 
    65       createAt: "2015-01-12 14:34:15",    //发帖时间 
    66       viewCount: 2,  //帖子浏览数  
    67       replyCount: 0,  //帖子回复数 
    68       recommend: 0, //是否推广位数据:0=否;1=是 
    69       recommendType: 1, //私语列表推广类型:1=话题贴通显推广;2=私密贴推广;3= 话题引导贴推广(当接口数据为话题列表数据时,该字段为0)   
    70       tagName: "杜蕾斯专场",  //专场标签(string类型,字段为空时表示无标签) 
    71       guestName: "毒舌辣妈", //特邀嘉宾标签 (string类型,字段为空时表示无标签) 
    72     } 
    73   ] 
    74 } 
    75  
    76 }}} 
    77 **返回参数说明** 
    78 ||= 参数名 =||= 参数含义 =|| 
    79 ||activitys||活动帖,个数最多两个|| 
    80  
    81 ---------- 
    82 === 4.2闺蜜专栏列表 === 
    83 '''(mrobot已完成开发,请连开发机进行测试)'''[[BR]] 
    84 mrobot接口:http://mrobot.pcbaby.com.cn/s-300/qzbd/bbs/getColumns.xsp?pageNo=1&pageSize=10&agent=2 [[BR]] 
    85 后端接口:http://bbs.pcbaby.com.cn/mobile/v2_5/bestie/getColumns.do?pageNo=1&pageSize=10&agent=2 [[BR]] 
    86  
    87 **说明** 
    88  
    89 > 一至五个专栏,无需翻页,每个专栏数据包括:专栏头像、专栏用户名、签名、动态(最新两条) [[BR]] 
    90  
    91 **缓存时间** 
    92  
    93 >5min 
    94  
    95 **提交方式** 
    96  
    97 > GET 
    98  
    99 **是否登录** 
    100  
    101 > 否 
    102  
    103 **数据来源** 
    104  
    105 >论坛后台 
    106  
    107 **参数** 
    108  
    109 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=|| 
    110 ||pageNo||页码||string||1 || ||页码|| 
    111 ||pageSize||每页条数||string||5|| ||每页条数,可选范围1-100|| 
    112 ||agent||app类型||string|| || ||2=亲子宝典IOS端,3=亲子宝典Android端|| 
    113 ||callback||回调函数||string|| ||非必需 ||回调函数|| 
    114 ||v||app版本号||string|| || ||版本号,v=260|| 
    115  
    116 **返回** 
    117  
    118 {{{#!java 
    119 { 
    120 columns:  [ 
    121  { 
    122     signature: "专栏签名", //专栏签名 
    123     authorFace: "http://i1.3conline.com/images/upload/upc/face/28/10/47/07/28104707_150x150",//专栏头像 
    124     authorId: 28104707,//专栏id 
    125     authorName: "情感小编",//专栏用户名 
    126     topics: //最新两条动态 
    127      [{ 
    128         message: "#嫁到婆家感觉最委屈的事#", 
    129         source: 1, 
    130         title: "#嫁到婆家感觉最委屈的事#", 
    131         topicId: 3162373 
    132      }, 
    133      {}] 
    134   } 
    135  ] 
    136 } 
    137  
    138 }}} 
    139 **返回参数说明** 
    140 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含义=|| 
    141 ||signature||专栏签名||authorFace||专栏头像|| 
    142 ||authorId||专栏id||authorName||专栏用户名|| 
    143 ||topics||最新两条动态|| 
    144  
    145 ---------- 
    146 === 4.3专栏详情列表 === 
    147 '''(mrobot已完成开发,请连开发机进行测试)'''[[BR]] 
    148 mrobot接口:http://mrobot.pcbaby.com.cn/s-300/qzbd/bbs/getUserColumn.xsp?uid=30454824&pageNo=1&pageSize=10&agent=2 [[BR]] 
    149 后端接口:http://bbs.pcbaby.com.cn/mobile/v2_5/bestie/getUserColumn.do?uid=30454824&pageNo=1&pageSize=10&agent=2 [[BR]] 
    150  
    151 **说明** 
    152  
    153 > 专栏列表,支持翻页 [[BR]] 
    154  
    155 **缓存时间** 
    156  
    157 >5min 
    158  
    159 **提交方式** 
    160  
    161 > GET 
    162  
    163 **是否登录** 
    164  
    165 > 否 
    166  
    167 **数据来源** 
    168  
    169 >论坛后台 
    170  
    171 **参数** 
    172  
    173 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=|| 
    174 ||uid||达人用户ID||string|| || ||达人用户ID|| 
    175 ||pageNo||页码||string||1 || ||页码|| 
    176 ||pageSize||每页条数||string||5|| ||每页条数,可选范围1-100|| 
    177 ||agent||app类型||string|| || ||2=亲子宝典IOS端,3=亲子宝典Android端|| 
    178 ||callback||回调函数||string|| ||非必需 ||回调函数|| 
    179 ||v||app版本号||string|| || ||版本号,v=260|| 
    180  
    181 **返回** 
    182  
    183 {{{#!java 
    184 { 
    185   pageNo: 1, 
    186   pageSize: 20, 
    187   topics: [ 
    188   { 
    189     message: "#嫁到婆家感觉最委屈的事#", 
    190     replyContent: "从生活了二十几年的环境,出嫁到一个陌生的环境,你是否感到诸多不惯?不同的家庭有着不同的生活习惯,你需要时间去慢慢适应。在这个过程中,有什么事让你感到委屈的吗? 回帖奖励:2015年8月25日前,踩中本帖总回复数20%、50%、80%分别奖20金币;踩中本帖第50楼、100、500、1000楼分别奖10金币。精彩回复被小编选定置顶,额外奖励10金币。 注意: 1、占领本帖前10楼的回复必须满20字,否则取消获奖资格。 2、同一用户只能占领前十楼之一,否则取消获奖资格。 3、回复不得灌水,若本帖回复数少于100,取消所有幸运楼层。", 
    191 replyTime: 1440386130000, 
    192     source: 1, 
    193     title: "#嫁到婆家感觉最委屈的事#", 
    194     topicId: 3162373, 
    195     viewCount: 2,  //帖子浏览数  
    196     replyCount: 0,  //帖子回复数 
    197   } 
    198   ], 
    199   total: 241 
    200 } 
    201  
    202 }}} 
    203 **返回参数说明** 
    204 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    205  
    206  
    207 ---------- 
    208  
    209 === 4.4发帖 === 
    210 '''(后端接口已完成)'''[[BR]] 
    211 后端正式接口:http://bbs.pcbaby.com.cn/rest/forums.jsp [[BR]] 
    212 后端测试接口:http://v14.pcbaby.com.cn/rest/forums.jsp [[BR]] 
    213  
    214 **说明** 
    215  
    216 > 发帖加上标签(后台可根据标签搜索),专栏发帖能通知到知心姐姐,接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.4发帖 [[BR]] 
    217  
    218 **缓存时间** 
    219  
    220 >无 
    221  
    222 **提交方式** 
    223  
    224 > POST 
    225  
    226 **是否登录** 
    227  
    228 > 是 
    229  
    230 **数据来源** 
    231  
    232 >论坛后台 
    233  
    234 **参数** 
    235  
    236 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=|| 
    237 ||forumId ||论坛ID||string|| || ||论坛ID|| 
    238 ||title ||帖子标题||string|| || ||帖子标题|| 
    239 ||anonymous ||是否匿名||string|| || ||1,匿名;0,不匿名|| 
    240 ||agent||app类型||string|| || ||2=亲子宝典IOS端,3=亲子宝典Android端|| 
    241 ||category||发帖分类||string|| || ||留空时为“原创”|| 
    242 ||message ||发帖内容||string|| || ||发帖内容|| 
    243 ||bUid  ||闺蜜专栏用户ID||string|| || ||加此参数时,发完贴会通知该uid对应的达人用户|| 
    244  
    245 **返回** 
    246  
    247 {{{#!java 
    248  
    249 a:forumId不合法时:(响应码:404) 
    250 { 
    251   "status" : 5 
    252   "message" : "找不到对应的论坛"  
    253 } 
    254  
    255 b:没有发帖权限时:(响应码:401) 
    256 返回消息格式同a,失败原因包含在message字段。 
    257  
    258 c:其他校验不通过时:(响应码:401) 
    259 返回消息格式同a,失败原因包含在message字段。 
    260  
    261 d:超过最大发帖数时:(响应码:401) 
    262 返回消息格式同a,失败原因包含在message字段。 
    263  
    264 e:标题为空时:(响应码:400) 
    265 返回消息格式同a,失败原因包含在message字段。 
    266  
    267 f:内容为空时:(响应码:400) 
    268 返回消息格式同a,失败原因包含在message字段。 
    269  
    270 g:标题为空时:(响应码:400) 
    271 返回消息格式同a,失败原因包含在message字段。 
    272  
    273 h:发到私密圈版块包含图片时:(响应码:400) 
    274 返回消息格式同a,失败原因包含在message字段。 
    275  
    276 i:其他异常:(响应码:500) 
    277 返回消息格式同a,失败原因包含在message字段。 
    278  
    279 j:发帖成功时:(响应码:201) 
    280 { 
    281   "status" : 0 
    282   "Location":"帖子URL", 
    283   "hasGold":true, 
    284   "goldCount":3 
    285 } 
    286  
    287 }}} 
    288 **返回参数说明** 
    289 ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    290  
    291  
    292 ---------- 
    293 == 5.生活圈 == 
    294 ---------- 
    295  
    296  
    297 === 5.1潮妈、圈子精华列表 === 
    298 '''(mrobot已完成开发,请连开发机进行测试)'''[[BR]] 
    299 mrobot接口:http://mrobot.pcbaby.com.cn/s-300/qzbd/bbs/getPicks.xsp?ie=utf-8&pageSize=20&pickType=pick3&maxLength=240&forums=1917,2130,1828,1799,1820,2140,1771,1776,2200&requestScr=wap&agent=2&noForums=1929&pageNo=1&cacheTime=1200&v=240&showImage=true [[BR]] 
    300 后端接口:http://bbs.pcbaby.com.cn/intf/forum/getPicks.do?ie=utf-8&pageSize=20&pickType=pick3&maxLength=240&forums=1917,2130,1828,1799,1820,2140,1771,1776,2200&requestScr=wap&agent=2&noForums=1929&pageNo=1&cacheTime=1200&v=240&showImage=true 
    301  
    302 **说明** 
    303  
    304 > 潮妈列表新增活动专区数据,圈子精华列表新增字段标明是否推广位,接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.2.1潮妈圈子精华列表 [[BR]] 
    305  
    306 **缓存时间** 
    307  
    308 >5min 
    309  
    310 **提交方式** 
    311  
    312 > GET 
    313  
    314 **是否登录** 
    315  
    316 > 否 
    317  
    318 **数据来源** 
    319  
    320 >论坛后台 
    321  
    322 **参数** 
    323  
    324 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=|| 
    325 ||forums||需要查询的版块ID||string|| || ||需要查询的版块ID,多个版块ID用半角逗号分隔。查找的信息也会包含其子版块。默认查询所有版块|| 
    326 ||noForums||要过滤的版块ID||string|| || ||要过滤的版块ID,多个版块ID用半角逗号分隔。查询将过滤掉这些版块及这些版块的子版块 || 
    327 ||agent||app类型||string|| || ||2=亲子宝典IOS端,3=亲子宝典Android端|| 
    328 ||pickType||精华类型||string||pickA || ||可选范围为,all,pickA,pickB,pick1,pick2,pick3,pick4,pick5。其中pickA和pickB查的都是普通精华,all为查询所有精华|| 
    329 ||maxLength||帖子内容需要截取的长度||string||240 || ||帖子内容需要截取的长度|| 
    330 ||callback||回调函数||string|| || ||回调函数|| 
    331 ||ie||输出内容的编码格式||string||GBK || ||输出内容的编码格式|| 
    332 ||showImage||是否输出帖子图片数组(前3张)||string|| || ||是否输出帖子图片数组(前3张)|| 
    333 ||requestScr||切换大小图||string||PC || ||当requestScr=wap时,结果中的images[]帖子图片尺寸大小为240*160|| 
    334 ||showSubject||是否显示论坛话题分类(最多3个)||string|| || ||是否显示论坛话题分类(最多3个)|| 
    335 ||pageNo||页码||string|| || ||页码|| 
    336 ||pageSize||每页条数||string|| || ||每页条数|| 
    337 ||showExtend||是否显示精华推广帖||string||false || ||默认false。可选[true,false]|| 
    338 ||v||app版本号||string|| || ||版本号,v=260|| 
    339  
    340 **返回** 
    341  
    342 {{{#!java 
    343 { 
    344   desc: "查询成功", 
    345   pageNo: 1, 
    346   pageSize: 20, 
    347   status: 0, 
    348   activitys://活动帖,最多两个 
    349   [  
    350    {  
    351      topicId: 2156386,          //帖子ID 
    352       title: "最难忘前任的那点",    //标题 
    353     } 
    354    ], 
    355   topics: [ 
    356     { 
    357     recommend:1,//标明是否推荐位,1是推荐位 
    358     babyBirthday: "", 
    359     bonus: -1, 
    360     containImage: true, 
    361     createAt: "2015-08-25 21:25:20", 
    362     createTime: 1440509120476, 
    363     forumId: 1917, 
    364     forumName: "宝宝秀场", 
    365     hasDoctorReply: false, 
    366     hasMummyMedia: false, 
    367     images: [], 
    368     message: "拍摄于中大校园 。 ", 
    369     pickTypes: {}, 
    370     replyCount: 0, 
    371     title: "短发萌娃元元的夏天。", 
    372     topicId: 3171428, 
    373     userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70", 
    374     userId: 1265767, 
    375     userName: "啃蘋果的壞蛋", 
    376     views: 40 
    377     }], 
    378   total: 927 
    379 } 
    380 }}} 
    381 **返回参数说明** 
    382 ||= 参数名 =||= 参数含义 =|| 
    383 ||recommend||是否推广位数据:0=否;1=是|| 
    384 ||activitys||活动帖,最多两个|| 
    385  
    386 ---------- 
    387 === 5.2帖子终端页 === 
    388 '''(mrobot已完成开发,请连开发机进行测试)'''[[BR]] 
    389 mrobot接口:http://mrobot.pcbaby.com.cn/v2/bbs/topics/3171428?pageNo=1&size=17&picRule=2&v=240&newQuote=true [[BR]] 
    390 后端接口: 
    391           http://bbs.pcbaby.com.cn/rest/topics/2155848?pageNo=1&size=17&picRule=2&newQuote=true&v=220&agent=0 [[BR]] 
    392           http://mdata.pconline.com.cn/pcbaby/user/allFace.jsp?act=findUnusedFaceIds&topicId=2155848 [[BR]] 
    393           http://mdata.pconline.com.cn/pcbaby/user/allFace.jsp?act=findAll [[BR]] 
    394           http://mdata.pconline.com.cn/pcbaby/user/userFace.jsp?topicId=2155848 [[BR]] 
    395  
    396 **说明** 
    397  
    398 > 回复按倒序排(新增传参),即最新的在最前面,图片采用400*的尺寸,接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.5帖子终端页 [[BR]] 
    399  
    400 **缓存时间** 
    401  
    402 >无 
    403  
    404 **提交方式** 
    405  
    406 > GET 
    407  
    408 **是否登录** 
    409  
    410 > 否 
    411  
    412 **数据来源** 
    413  
    414 >论坛后台 
    415  
    416 **参数** 
    417  
    418 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
    419 ||reverse||回复的排序方式||string|| || ||0为倒序,1为正序|| 
    420 ||topics||帖子id||string||无||是||帖子id|| 
    421 ||size||帖子内容字体大小||string|| || || || 
    422 ||pageNo||当前所在页数||string|| || || || 
    423 ||picRule||图片默认显示规则||string|| || ||0为显示小图,1为显示文字链接;2为显示大图|| 
    424 ||v||版本号||string|| || ||v=260|| 
    425 ||newQuote||控制新旧版回帖引用内容的样式||string||false || ||true或false,默认false|| 
    426 ||desc||是否倒序显示回帖(主楼除外)||string||false || ||true或false,默认false|| 
    427 >设置header  Cookie = "common_session_id=xxxx" 
    428  
    429 **返回** 
    430 >html页面 
    431  
    432 ----------