一.基本约定
1.开发机、测试机代理地址:
mrobot开发机代理:192.168.10.199 端口:1080
mrobot测试机代理:192.168.10.198 端口:1080
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
二.接口列表
1.0 个人中心
1.1 问答回复数
备注:获取问答回复数
接口开发:
mrobot接口url:
后端url:
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:
请求参数:
设置header Cookie = "common_session_id=xxxx";
v = 2.2 //版本号
返回参数
{
"ret": 0, //返回状态,0=成功,非0=失败
"questionsCount": 10, //问答回复数
"desc": "提示信息" //错误提示信息
}
1.2 我的问答数量
备注:获取我的问答数量
接口开发:卢海潮
mrobot请求URL:
后端请求URL:http://kuaiwen.pcbaby.com.cn/intf/app/my_questions_nums.jsp
接口说明:http://rdtrac.pc.com.cn/kuaiwen_baby/ticket/9
HTTP请求方式:get
是否需要登录:是
返回格式:JSON
缓存方式:无
缓存时间:无
请求参数:
设置header Cookie = "common_session_id=xxxx";
v = 2.2 //版本号
返回参数
{
solvedCount:已解决数量
unsolvedCount:未解决数量
}
分割线(备注:接口1.3-1.6的后端接口已有,mrobot做中转)
1.3 是否已收藏
备注:判断是否已收藏
接口开发:吴全贵、卢海潮
mrobot请求URL:
后端接口Url:http://my.pcbaby.com.cn/collection/intf/collection/app/check_collected.jsp
HTTP请求方式:get
是否需要登录:是
返回格式:JSON
请求参数:
common_session_id:需通行证登录,设置用户COOKIE
type:收藏对象类型(0文章;5帖子;1百科;6问答;7课程;8食谱)
id: 收藏对象标识码,即收藏对象ID
v = 2.2 //版本号
返回参数
{
"result":1, //状态码,1=正常返回,0=返回错误
"code":1, //收藏结果验证码,1=已收藏,0=未收藏
"msg":"取消收藏成功" //提示信息
}
1.4 批量查询是否已收藏
备注:批量查询是否已收藏(该接口符合Android V2.0版本需求,iOS没用到)
接口开发:吴全贵、卢海潮
mrobot请求URL:
后端请求URL:http://my.pcbaby.com.cn/collection/intf/collection/app/iscollect_batch.jsp
HTTP请求方式:get
是否需要登录:是
返回格式:JSON
请求参数:
common_session_id:需通行证登录,设置用户COOKIE
ids //查询id字符串。
格式:ids=类型Id,查询文章id(中间用英文逗号分隔)&ids=类型Id,查询文章id(中间用英文逗号分隔)
例如:ids=1,10085&ids=8,10086& ids=6,10087
v = 2.2 //版本号
返回参数
{ "accountId":20848253, //用户ID
"checks": "[{
\"objectId\":10085, //收藏对象Id
\"objectType\":1, //收藏类型,(0文章;5帖子;1百科;6问答;7课程;8食谱)
\"result\":-1 //查询结果,1=已收藏,-1=未收藏
}]"
}
1.5 删除收藏
备注:删除收藏
接口开发:吴全贵、卢海潮
请求URL:http://my.pcbaby.com.cn/collection/intf/collection/app/uncollect.jsp
HTTP请求方式:post
是否需要登录:是
返回格式:JSON
请求参数:
type:收藏对象类型(0文章;5帖子;1百科;6问答;7课程;8食谱)
common_session_id:登录用户id
id: 收藏对象标识码,即收藏对象ID
返回参数:
{
“msg”:”取消收藏成功”, //提示信息
“result”:1 //1=取消收藏成功,0=该文章不存在或已取消收藏
}
1.6 添加收藏
备注:添加收藏
接口开发:吴全贵、谢思华
请求URL:http://my.pcbaby.com.cn/collection/intf/collection/app/collect.jsp
HTTP请求方式:post
是否需要登录:是
返回格式:JSON
请求参数:
common_session_id:需通行证登录,设置用户COOKIE
type:收藏对象类型(0文章;5帖子;1百科;6问答;7课程;8食谱)
id: 收藏对象标识码,即收藏对象ID
title:文章标题,收藏频道和工具时才需要传此参数
返回参数:JSON
{
"msg": "收藏成功", //提示信息
"result":1, // 1=收藏成功,0=收藏失败
}
2.0 崔玉涛视频
2.1 崔玉涛专栏首页
备注:崔玉涛专栏首页接口(v2.2开始崔玉涛视频列表增加播放次数字段)
mrobot接口url:http://mrobot.pcbaby.com.cn/v2/qzbd/cytHome
后端接口url:
http://www.pcbaby.com.cn/app/qzbd2/cyt/
http://ivy.pconline.com.cn/adpuba/show?id=pc.khd.zx.btxfldxj.&media=js
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:15分钟
请求参数:
v = 2.2 //版本号
返回参数:
{
"status": 0, //状态码 0正常返回 非0请求错误
"desc": "", //提示信息 status=0提示信息为空;status非0,给出对应的出错提示信息
"authorInformation" : //专家信息
{
"face" : "" //专家头像
"name" : "" // 专家姓名
"title" : "" //职称
"position" : "" //职务
"introduction" : "" //专家介绍
},
"ads": //广告
[
{
"image": "" //广告图片
"toUri" : "" //跳转uri
}
],
"hot": //育儿热点
{
"title":"育儿热点",
"section":[
{
"categoryId": //分类id
"title": //分类标题
"image": //图片
}
...
]
},
"video": //在线视频
{
"title":"在线视频",
"section":[
{
"articleId": "1987318",
"date": "2014-12-11",
"image": "http://img0.pcbaby.com.cn/pcbaby/zhuanjia/jtye/shipin/1412/yekebuting.jpg",
"title": "亲子课堂:孩子夜咳不停怎么回事?",
"count":"10" //视频播放次数
}
...
]
},
"question": //问答专栏
{
"title":"问答专栏",
"section":[
{
"articleId": "2042246",
"num": "3",//专栏期数id
"date": "2015-01-06",
"expertId": "29003920",
"image": "http://www1.pcbaby.com.cn/03daodu.jpg",
"title": "孩子经常发烧怎么办?"
}
...
]
},
"article": //育儿文章
{
"title":"育儿文章",
"section":[
{
"articleId": "2048505",
"date": "2015-01-06",
"image": "http://img0.pcbaby.com.cn/pcbaby/1501/06/g_2048505_1420534505891.jpg",
"preview": "育儿路上烦恼多,怎么才能护理好孩子的日常起居?怎么可以培养孩子的各项能力?遇到了这些问题就赶紧来提问吧!除了能得到专家的答疑,还有机会赢得崔玉涛医生的育儿书籍一本哦。",
"title": "【提问有礼】赢崔玉涛育儿书"
}
...
]
}
}
2.2视频列表
备注:视频列表(接口已完成,使用请连开发机代理)
mrobot接口url:http://mrobot.pcbaby.com.cn/v2/qzbd/cytList?type=video&pageNo=1&pageSize=20
后端接口url:http://www.pcbaby.com.cn/app/qzbd2/cyt/video/
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:15分钟
请求参数:
pageNo //第几页
pageSize //每页显示多少条
type //类型,此次type=video
v = 2.2 //版本号
返回参数:
{
"data": [
{
"articleId": "1987318",
"date": "2014-12-11",
"image": "http://img0.pcbaby.com.cn/pcbaby/zhuanjia/jtye/shipin/1412/yekebuting.jpg",
"title": "亲子课堂:孩子夜咳不停怎么回事?",
"count":"10" //视频播放次数
}
],
"pageCount": 1,
"pageNo": 1,
"pageSize": 20,
"total": 1
}
2.3统计视频播放次数
备注:统计单个视频播放次数
mrobot接口url:
后端接口url:http://v.pcbaby.com.cn/__counter.jsp?video=1162
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:
请求参数:
video //视频id
v = 2.2 //版本号
返回参数:(附:原始接口返回200状态码表示成功)
{
"ret": 0, //返回状态,0=成功,非0 =失败
"desc": "提示信息" //错误提示信息
}
3.0 交流圈
3.1 私密圈
3.1.1 私语、话题列表
备注:获取私密圈私语、话题列表
(参考接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.7私密圈帖子列表-私语)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:
请求参数:
type:1私语(默认),2话题
pageNo:1 //页码
pageSize:20 //每页条数
maxLength:240 //帖子内容需要截取的长度,默认240个字节
v = 2.2 //版本号
返回参数,成功:
{
pageNo: 1, //页码
pageSize: 20, //每页条数
total: 15163, //总数量
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= 话题引导贴推广(当取话题列表数据时,该字段忽略)
tagName: "杜蕾斯专场", //专场标签(string类型,字段为空时表示无标签)
guestName: "毒舌辣妈", //特邀嘉宾标签 (string类型,字段为空时表示无标签)
}
]
}
3.1.2 闺蜜列表
备注:获取私密圈-闺蜜列表
(参考接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.9私密圈闺蜜帖子列表)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:
请求参数:
pageNo:1 //页码
pageSize:20 //每页条数
v = 2.2 //版本号
返回参数,成功:
{
pageNo: 1, //页码
pageSize: 20, //每页条数
total: 15163, //总数量
topics: [
{
replyAuthorFace:"http://img.pcbaby.com.cn/images/upload/upc/tx/pcbabyfk/1412/18/c0/793654_1418869304618_180x180.jpg", //显示闺蜜达人在个人中心的头像(180x180)
replyAuthorName: "毒舌辣妈", //显示闺蜜达人在个人中心的昵称
replyContent: "我觉得大部分女人都会比较希望老公终身不娶的女儿!", //回帖内容
replyTime: 1420790175000, //回帖时间
source: 0, //列表来源 0=私语,1=话题
message: "常常会想一个问题就是如果我不幸离世了,我的老公...", //主贴内容
topicId: 2151480, //帖子ID
viewsNum: 33, //帖子查看数量
commentNum: 6, //帖子评论数
}
]
}
3.2 生活圈
3.2.1 潮妈、最新-精华列表
备注:生活圈潮妈列表,最新-精华列表,时间倒序
(参考接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.1生活圈精华帖子列表 ,更改返回图片尺寸)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:http://bbs.pcbaby.com.cn/intf/forum/getPicks.do
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:有
缓存时间:
请求参数:
forums= 1917,2130,1828,1799,1820,2140,1771,1776,2200;需要查询的版块ID,多个版块ID用半角逗号分隔。查找的信息也会包含其子版块
//(说明:潮妈forums参数值固定为1917,2130,1828,1799,1820,2140,1771,1776,2200。其它某个论坛的ID根据列表得到的forums ID传入即可)
noForums= 1929;要过滤的版块ID,多个版块ID用半角逗号分隔。查询将过滤掉这些版块及这些版块的子版块(说明:潮妈才需要用到的参数,固定为1929)
pickType= pick3;精华类型//剩余type指的是什么呢?(说明:潮妈,pickType为pick3,其它论坛pickType为all)
maxLength:帖子内容需要截取的长度,默认240个字节
showImage=true;显示图片
ie=utf-8;输出内容的编码格式
cacheTime=1200;缓存时间,单位为秒
pageNo:1 //页码
pageSize:10 //每页条数
v = 2.2 //版本号
返回参数:
{
desc: "查询成功", //状态描述
pageNo: 1, //页码
pageSize: 20, //每页条数
status: 0, //状态码
topics: [
{
createAt: "2015-01-11 19:30:35", //帖子的创建时间
images: [ //帖子图片组成的数组
"http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752585_1420975033163_1024x1024.jpg",
"http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752586_1420975112551_1024x1024.jpg",
"http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752588_1420975163834_1024x1024.jpg"
],
title: "超可爱萌妹子融化人心", //帖子标题
message: " 《雯雯 萌萌哒》超级可爱的萌妹子,完全可以萌化到心底里...", //帖子内容
topicId: 2155848, //帖子id
userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70", //用户头像
userId: 1265767, //用户ID
userName: "啃蘋果的壞蛋", //用户昵称
views: 22, //帖子浏览数
replyCount: 2, //帖子回复数
}
],
total: 515 //总帖子数
}
3.2.2 圈子列表
备注:生活圈圈子列表
(参考接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.2生活圈栏目列表)
接口开发:庄焕滨
mrobot接口URL:
后端接口URL:http://www.pcbaby.com.cn/app/qzbd2/shqgd/
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:无
请求参数:
v = 2.2 //版本号
返回参数
{
channels:[
{
id: 论坛id
name: 论坛名字
image: 论坛图片
des1: 论坛描述1
des2: 论坛描述2
}
]
}
3.2.3 最新列表
备注:生活圈最新列表
(改为只出全站APP所发的最新内容,按照发帖时间倒序,需即时显示,含三个推广位)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:1小时
请求参数:
pageNo://页码
pageSize://每页条数
v = 2.2 //版本号
返回参数,成功:
{
fids: "1", //版块id
pageNo: 1,
pageSize: 20,
topics: [
{
createAt: "2015-01-11 15:17:20", //发帖时间
message: "金币兑换的活动被我赶上好时候了。", //内容
replyCount: 3, //回复数
title: "【金币兑换】终于收到宝贝与我!", //标题
topicId: 2155710, //帖子ID
userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/25/23/72/54/25237254_50x50", //用户头像
userId: 25237254, //用户ID
userName: "馨悦妈妈", //用户昵称
viewCount: 20, //帖子查看数
recommend: 0, //是否为推广位数据:0=否;1=是
}
],
total: 639 //总条数
}
3.2.3.1 最新-最新列表
备注:生活圈最新-某个版块最新列表(按照发帖时间倒序,需即时显示,含一个推广位)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:1小时
请求参数:
fids://指定版块id
pageNo://页码
pageSize://每页条数
v = 2.2 //版本号
返回参数,成功:
{
fids: "1", //版块id
pageNo: 1,
pageSize: 20,
topics: [
{
createAt: "2015-01-11 15:17:20", //发帖时间
message: "金币兑换的活动被我赶上好时候了。", //内容
replyCount: 3, //回复数
title: "【金币兑换】终于收到宝贝与我!", //标题
topicId: 2155710, //帖子ID
userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/25/23/72/54/25237254_50x50", //用户头像
userId: 25237254, //用户ID
userName: "馨悦妈妈", //用户昵称
viewCount: 20, //帖子查看数
recommend: 0, //是否为推广位数据:0=否;1=是
}
],
total: 639 //总条数
}
3.3 回帖
备注:回帖、回楼接口
(参照接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.5回帖接口 , 去除可匿名参数)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:post
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:
请求参数:
topicId:主题ID
title:主题标题
message:内容
replyToId:回复楼层的id
agent:终端类型(WAP:1、iOS:2、ANDROID:3)
v = 2.2 //版本号
设置header Cookie = "common_session_id=xxxx"
返回参数:
发帖成功,返回HTTP响应头为201,即内容创建成功
{
"Location": "http://bbs.pcbaby.com.cn/post-2156187_39095567.html"
}
3.4 发帖
备注:发帖接口
(参照接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.4发帖接口)
接口开发:丁健勇
mrobot接口URL:
后端接口URL:
HTTP请求方式:post
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:
请求参数:
forumId:板块ID //(说明:从论坛列表进入某个论坛时能获得改论坛的ID。发帖是在某个论坛内发帖的,该ID为这个论坛的ID,即从论坛列表进入时可获得。私密圈版块ID为2270)
title:主题标题
message:正文内容
agent:终端类型(WAP:1、iOS:2、ANDROID:3)
v = 2.2 //版本号
设置header Cookie = "common_session_id=xxxx";
返回参数:
发帖成功,返回HTTP响应头为201,即内容创建成功
{
"Location": "http://bbs.pcbaby.com.cn/topic-2156187.html", //帖子URL
"goldCount": 1, //发帖获得金币数量
"hasGold": true //发帖是否获得金币
}
3.5 帖子终端页
备注:帖子终端页
1、参照接口:http://trac.pc.com.cn/iphone/wiki/baby/interface#a4.3帖子终端
2、html页面,V2.2版本更改帖子终端样式