Changes between Initial Version and Version 1 of baby2.6_developers/interface

Timestamp:

09/08/2015 09:41:32 AM (11 years ago)

Author:

wuhuixuan

Comment:

--

baby2.6_developers/interface

@@ +1 @@
+[[TOC]]
+
+= 亲子宝典2.6.0接口文档 =
+>mrobot代理环境说明： 
+  192.168.10.198:1080(192.168.74.80)[[BR]] 
+  192.168.10.199:1080 ，连的是dev40的开发环境（192.168.75.40）[[BR]] 
+
+== 1.私密圈 ==
+----------
+=== 1.1私语列表 ===
+'''(mrobot已完成开发，请连开发机进行测试)'''[[BR]]
+mrobot接口：http://mrobot.pcbaby.com.cn/s/qzbd/bbs/getSecretTopics.xsp [[BR]]
+后端接口：http://bbs.pcbaby.com.cn/mobile/v2_2/getSecretTopics.do 
+
+**说明**
+
+> 新增置顶的活动专区，活动帖个数最多两个，返回数据需要新增一个数组返回活动帖 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||type||列表类型||string|| ||是||1=私语，2=话题||
+||pageNo||页码||string|| || ||页码||
+||pageSize||每页条数||string|| || ||每页条数||
+||maxLength||内容最大长度||string||240 || || ||
+||agent||app类型||string|| || ||2=亲子宝典IOS端，3=亲子宝典Android端||
+||v||app版本号||string|| || ||版本号，v=260||
+**返回**
+
+{{{#!java
+{
+  pageNo: 1,    //当前页码
+  pageSize: 20, //每页条数，这里具体是指topics的个数，不包括activitys的
+  total: 15163, //总数量
+  activitys：//活动帖，最多两个
+  [ 
+   { 
+     topicId: 2156386,          //帖子ID
+      title: "最难忘前任的那点",    //标题
+    }
+   ]，
+  topics: [
+    { 
+      topicId: 2156386,          //帖子ID
+      title: "最难忘前任的那点",    //标题
+      message: "最难忘前任的那点", //帖子内容（当recommend＝1且recommendType＝3时，这里为“引导话题贴内容”）
+      createAt: "2015-01-12 14:34:15",    //发帖时间
+      viewCount: 2,  //帖子浏览数 
+      replyCount: 0,  //帖子回复数
+      recommend: 0, //是否推广位数据：0＝否；1=是
+      recommendType: 1, //私语列表推广类型：1＝话题贴通显推广；2=私密贴推广；3= 话题引导贴推广（当接口数据为话题列表数据时，该字段为0）  
+      tagName: "杜蕾斯专场",  //专场标签（string类型，字段为空时表示无标签）
+      guestName: "毒舌辣妈", //特邀嘉宾标签 (string类型，字段为空时表示无标签）
+    }
+  ]
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+||activitys||活动帖，个数最多两个||
+
+----------
+=== 1.2闺蜜专栏列表 ===
+'''(mrobot已完成开发，请连开发机进行测试)'''[[BR]]
+mrobot接口：http://mrobot.pcbaby.com.cn/s-300/qzbd/bbs/getColumns.xsp?pageNo=1&pageSize=10&agent=2 [[BR]]
+后端接口：http://bbs.pcbaby.com.cn/mobile/v2_5/bestie/getColumns.do?pageNo=1&pageSize=10&agent=2 [[BR]]
+
+**说明**
+
+> 一至五个专栏，无需翻页，每个专栏数据包括：专栏头像、专栏用户名、签名、动态（最新两条） [[BR]]
+
+**缓存时间**
+
+>5min
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||pageNo||页码||string||1 || ||页码||
+||pageSize||每页条数||string||5|| ||每页条数，可选范围1-100||
+||agent||app类型||string|| || ||2=亲子宝典IOS端，3=亲子宝典Android端||
+||callback||回调函数||string|| ||非必需 ||回调函数||
+||v||app版本号||string|| || ||版本号，v=260||
+
+**返回**
+
+{{{#!java
+{
+columns:  [
+ {
+    signature: "专栏签名", //专栏签名
+    authorFace: "http://i1.3conline.com/images/upload/upc/face/28/10/47/07/28104707_150x150",//专栏头像
+    authorId: 28104707,//专栏id
+    authorName: "情感小编",//专栏用户名
+    topics: //最新两条动态
+     [{
+        message: "#嫁到婆家感觉最委屈的事#",
+        source: 1,
+        title: "#嫁到婆家感觉最委屈的事#",
+        topicId: 3162373
+     },
+     {}]
+  }
+ ]
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含义=||
+||signature||专栏签名||authorFace||专栏头像||
+||authorId||专栏id||authorName||专栏用户名||
+||topics||最新两条动态||
+
+----------
+=== 1.3专栏详情列表 ===
+'''(mrobot已完成开发，请连开发机进行测试)'''[[BR]]
+mrobot接口：http://mrobot.pcbaby.com.cn/s-300/qzbd/bbs/getUserColumn.xsp?uid=30454824&pageNo=1&pageSize=10&agent=2 [[BR]]
+后端接口：http://bbs.pcbaby.com.cn/mobile/v2_5/bestie/getUserColumn.do?uid=30454824&pageNo=1&pageSize=10&agent=2 [[BR]]
+
+**说明**
+
+> 专栏列表，支持翻页 [[BR]]
+
+**缓存时间**
+
+>5min
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||uid||达人用户ID||string|| || ||达人用户ID||
+||pageNo||页码||string||1 || ||页码||
+||pageSize||每页条数||string||5|| ||每页条数，可选范围1-100||
+||agent||app类型||string|| || ||2=亲子宝典IOS端，3=亲子宝典Android端||
+||callback||回调函数||string|| ||非必需 ||回调函数||
+||v||app版本号||string|| || ||版本号，v=260||
+
+**返回**
+
+{{{#!java
+{
+  pageNo: 1,
+  pageSize: 20,
+  topics: [
+  {
+    message: "#嫁到婆家感觉最委屈的事#",
+    replyContent: "从生活了二十几年的环境，出嫁到一个陌生的环境，你是否感到诸多不惯？不同的家庭有着不同的生活习惯，你需要时间去慢慢适应。在这个过程中，有什么事让你感到委屈的吗？ 回帖奖励：2015年8月25日前，踩中本帖总回复数20%、50%、80%分别奖20金币；踩中本帖第50楼、100、500、1000楼分别奖10金币。精彩回复被小编选定置顶，额外奖励10金币。 注意： 1、占领本帖前10楼的回复必须满20字，否则取消获奖资格。 2、同一用户只能占领前十楼之一，否则取消获奖资格。 3、回复不得灌水，若本帖回复数少于100，取消所有幸运楼层。",
+replyTime: 1440386130000,
+    source: 1,
+    title: "#嫁到婆家感觉最委屈的事#",
+    topicId: 3162373，
+    viewCount: 2,  //帖子浏览数 
+    replyCount: 0,  //帖子回复数
+  }
+  ],
+  total: 241
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+
+
+----------
+
+=== 1.4发帖 ===
+'''(后端接口已完成)'''[[BR]]
+后端正式接口：http://bbs.pcbaby.com.cn/rest/forums.jsp [[BR]]
+后端测试接口：http://v14.pcbaby.com.cn/rest/forums.jsp [[BR]]
+
+**说明**
+
+> 发帖加上标签（后台可根据标签搜索），专栏发帖能通知到知心姐姐，接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.4发帖 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> POST
+
+**是否登录**
+
+> 是
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||forumId ||论坛ID||string|| || ||论坛ID||
+||title ||帖子标题||string|| || ||帖子标题||
+||anonymous ||是否匿名||string|| || ||1，匿名；0，不匿名||
+||agent||app类型||string|| || ||2=亲子宝典IOS端，3=亲子宝典Android端||
+||category||发帖分类||string|| || ||留空时为“原创”||
+||message ||发帖内容||string|| || ||发帖内容||
+||bUid  ||闺蜜专栏用户ID||string|| || ||加此参数时，发完贴会通知该uid对应的达人用户||
+
+**返回**
+
+{{{#!java
+
+a：forumId不合法时：（响应码：404）
+{
+  "status" : 5
+  "message" : "找不到对应的论坛" 
+}
+
+b：没有发帖权限时：（响应码：401）
+返回消息格式同a，失败原因包含在message字段。
+
+c：其他校验不通过时：（响应码：401）
+返回消息格式同a，失败原因包含在message字段。
+
+d：超过最大发帖数时：（响应码：401）
+返回消息格式同a，失败原因包含在message字段。
+
+e：标题为空时：（响应码：400）
+返回消息格式同a，失败原因包含在message字段。
+
+f：内容为空时：（响应码：400）
+返回消息格式同a，失败原因包含在message字段。
+
+g：标题为空时：（响应码：400）
+返回消息格式同a，失败原因包含在message字段。
+
+h：发到私密圈版块包含图片时：（响应码：400）
+返回消息格式同a，失败原因包含在message字段。
+
+i：其他异常：（响应码：500）
+返回消息格式同a，失败原因包含在message字段。
+
+j：发帖成功时：（响应码：201）
+{
+  "status" : 0
+  "Location":"帖子URL",
+  "hasGold":true,
+  "goldCount":3
+}
+
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
+
+
+----------
+== 2.生活圈 ==
+----------
+
+
+=== 2.1潮妈、圈子精华列表 ===
+'''(mrobot已完成开发，请连开发机进行测试)'''[[BR]]
+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]]
+后端接口：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
+
+**说明**
+
+> 潮妈列表新增活动专区数据，圈子精华列表新增字段标明是否推广位，接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.2.1潮妈圈子精华列表 [[BR]]
+
+**缓存时间**
+
+>5min
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必需 =||=说明=||
+||forums||需要查询的版块ID||string|| || ||需要查询的版块ID，多个版块ID用半角逗号分隔。查找的信息也会包含其子版块。默认查询所有版块||
+||noForums||要过滤的版块ID||string|| || ||要过滤的版块ID,多个版块ID用半角逗号分隔。查询将过滤掉这些版块及这些版块的子版块 ||
+||agent||app类型||string|| || ||2=亲子宝典IOS端，3=亲子宝典Android端||
+||pickType||精华类型||string||pickA || ||可选范围为，all,pickA,pickB,pick1,pick2,pick3,pick4,pick5。其中pickA和pickB查的都是普通精华，all为查询所有精华||
+||maxLength||帖子内容需要截取的长度||string||240 || ||帖子内容需要截取的长度||
+||callback||回调函数||string|| || ||回调函数||
+||ie||输出内容的编码格式||string||GBK || ||输出内容的编码格式||
+||showImage||是否输出帖子图片数组（前3张）||string|| || ||是否输出帖子图片数组（前3张）||
+||requestScr||切换大小图||string||PC || ||当requestScr=wap时，结果中的images[]帖子图片尺寸大小为240*160||
+||showSubject||是否显示论坛话题分类（最多3个）||string|| || ||是否显示论坛话题分类（最多3个）||
+||pageNo||页码||string|| || ||页码||
+||pageSize||每页条数||string|| || ||每页条数||
+||showExtend||是否显示精华推广帖||string||false || ||默认false。可选[true,false]||
+||v||app版本号||string|| || ||版本号，v=260||
+
+**返回**
+
+{{{#!java
+{
+  desc: "查询成功",
+  pageNo: 1,
+  pageSize: 20,
+  status: 0,
+  activitys：//活动帖，最多两个
+  [ 
+   { 
+     topicId: 2156386,          //帖子ID
+      title: "最难忘前任的那点",    //标题
+    }
+   ]，
+  topics: [
+    {
+    recommend：1，//标明是否推荐位，1是推荐位
+    babyBirthday: "",
+    bonus: -1,
+    containImage: true,
+    createAt: "2015-08-25 21:25:20",
+    createTime: 1440509120476,
+    forumId: 1917,
+    forumName: "宝宝秀场",
+    hasDoctorReply: false,
+    hasMummyMedia: false,
+    images: [],
+    message: "拍摄于中大校园 。 ",
+    pickTypes: {},
+    replyCount: 0,
+    title: "短发萌娃元元的夏天。",
+    topicId: 3171428,
+    userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70",
+    userId: 1265767,
+    userName: "啃蘋果的壞蛋",
+    views: 40
+    }],
+  total: 927
+}
+}}}
+**返回参数说明**
+||= 参数名 =||= 参数含义 =||
+||recommend||是否推广位数据：0＝否；1=是||
+||activitys||活动帖，最多两个||
+
+----------
+=== 2.2帖子终端页 ===
+'''(mrobot已完成开发，请连开发机进行测试)'''[[BR]]
+mrobot接口：http://mrobot.pcbaby.com.cn/v2/bbs/topics/3171428?pageNo=1&size=17&picRule=2&v=240&newQuote=true [[BR]]
+后端接口：
+          http://bbs.pcbaby.com.cn/rest/topics/2155848?pageNo=1&size=17&picRule=2&newQuote=true&v=220&agent=0 [[BR]]
+          http://mdata.pconline.com.cn/pcbaby/user/allFace.jsp?act=findUnusedFaceIds&topicId=2155848 [[BR]]
+          http://mdata.pconline.com.cn/pcbaby/user/allFace.jsp?act=findAll [[BR]]
+          http://mdata.pconline.com.cn/pcbaby/user/userFace.jsp?topicId=2155848 [[BR]]
+
+**说明**
+
+> 回复按倒序排（新增传参），即最新的在最前面，图片采用400*的尺寸，接口说明http://trac.pc.com.cn/iphone/wiki/baby2.2_developers/interface#a3.5帖子终端页 [[BR]]
+
+**缓存时间**
+
+>无
+
+**提交方式**
+
+> GET
+
+**是否登录**
+
+> 否
+
+**数据来源**
+
+>论坛后台
+
+**参数**
+
+||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||
+||reverse||回复的排序方式||string|| || ||0为倒序，1为正序||
+||topics||帖子id||string||无||是||帖子id||
+||size||帖子内容字体大小||string|| || || ||
+||pageNo||当前所在页数||string|| || || ||
+||picRule||图片默认显示规则||string|| || ||0为显示小图，1为显示文字链接；2为显示大图||
+||v||版本号||string|| || ||v=260||
+||newQuote||控制新旧版回帖引用内容的样式||string||false || ||true或false，默认false||
+||desc||是否倒序显示回帖（主楼除外）||string||false || ||true或false，默认false||
+>设置header  Cookie = "common_session_id=xxxx"
+
+**返回**
+>html页面
+
+----------