Table of Contents
一.基本约定
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
8.涉及接口都需要传请求参数:v = 240 //版本号(数字)
二.接口列表
1.0首页
备注:0~1岁(不包含一岁)育儿首页接口采用新版(与2.3怀孕首页排版一致),1岁~6岁育儿首页不变(继续使用2.3版本的育儿首页);
怀孕|0~1岁育儿首页的精彩话题排版改为左一图右文字的形式;怀孕|0~1岁育儿首页新增文字链
说明:v2.3.0怀孕首页接口 http://trac.pc.com.cn/iphone/wiki/baby2.3_developers/interface#a1.0怀孕首页
1)mrobot接口url:
备孕首页: http://mrobot.pcbaby.com.cn/v2/qzbd/home/1?v=240
怀孕首页: http://mrobot.pcbaby.com.cn/v2/qzbd/home/2?v=240&agent=2&lemmaId=13776
0~1岁育儿首页: http://mrobot.pcbaby.com.cn/v2/qzbd/home/3?v=240&agent=2&lemmaId=41
1~6岁育儿首页: http://mrobot.pcbaby.com.cn/v2/qzbd/home/3?v=240
2)后端接口:
备孕首页: http://www.pcbaby.com.cn/app/qzbd2/bysy/
怀孕首页: http://www.pcbaby.com.cn/app/qzbd2/hysy/
育儿首页: http://www.pcbaby.com.cn/app/qzbd2/yesy/
每日知识接口: http://baike.pcbaby.com.cn/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=31
精彩话题: http://bbs.pcbaby.com.cn/mobile/v2_3/getWonderfulTopic.do?homePosition=rearindex&agent=2
内容维护区: http://www.pcbaby.com.cn/app/qzbd2/yesy/yejson/1507/intf6922.js
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:15分钟
请求参数:
参数名 类型 必须 说明 id string 是 栏目id v string 是 版本号,即:240 lemmaId string 是 时间轴id agent string 是 客户端标识,IOS:2,Android:3
返回参数:
{
extend:[ //推广的文字链,文字链只分阶段不分时间轴,如果没有则返回空
{
title:"这里是文字链啊,分阶段不分时间轴,这个文字链的文字客户端一定要分行显示完整啊囧,不完整不行啊",
url:"http://www.baidu.com",
}
],
focus:[ //焦点图数据
{
id: // id:"articleId=234&expertId=112&num=111"( 推“专栏详情”的推广时id为文章id&专家id&专栏期数id)
image:
title:
type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);
问答(10终端);百科(11终端);崔玉涛视频(12视频文章终端);专栏详情(13)
url:(活动、工具终端打开需要url,不需要时为空字符串)
}
],
"timeline": { //每日知识内容
"index": [ //发育指标
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容(读取字段)
"description": "胎长约38.5cm,胎重约1600g。这时候他已有4个佛手柑那么重了。现在,你的体重可能已经增加了8.5kg。小腹更加突出了。",
"id": 245,
"image": "http://img.pcbaby.com.cn/images/upload/upc/tx/baby_baike/1408/01/c0/36948482_1406875934412.jpg",
"title": "胎儿发育和妈妈变化",
"type": "11"
}
],
"point": [ //知识点概括
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容(读取字段)
"description": "进入孕后期,你可能会感到尿频和总有尿不完的感觉。这个阶段有将近80%的孕妇为尿频困扰,很多孕妈妈在夜间需要更频繁地起床跑厕所。",
"id": 511,
"title": "孕妇尿频",
"type": "11"
},
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容(读取字段)
"description": "孕期气短通常没有什么大碍,也很正常。在日常生活中把节奏放慢一些,活动或运动的时候,不要太勉强自己。",
"id": 633,
"title": "孕妇气短",
"type": "11"
}
],
}
recommendChannel:[ //热门栏目
{
title: //根据栏目名称跳转至对应模块
type: //热门栏目类型(type=5表示家庭育儿)
//type=1 阅读,type=2 百科,type=3 交流圈,type=4 每日知识,type=5 家庭育儿,type=6 问答,type=7 活动,type=8 工具,type=9 每日食谱
}
],
recommendContent: //内容维护区(这里列出了所有内容类型的数据,接口实际只会返回其中的一种类型)
[
{
type:1 //类型:图集;内容类型(type=1 图集,type=2 视频,type=3 专家视点,type=4 问答专栏(已去除),type=5 精彩活动,type=6 资讯文章,type=7 百科文章,type=8 生活圈帖子,type=9 私密圈帖子,type=10 html页)
image: //图片url
title: //标题
imageCount:13 //图集总数
albumsId: //图集id
label:"宝宝护理" //图集标签
},
{
type:2 //类型:视频
image: //图片url
title: //标题
preview:"孩子经常发烧" //简介
articleId: "2042246", //文章id
videoId: "2006", //视频id
},
{
type:3 //类型:专家视点
image: //图片url
title: //标题
url: //专家视点页面url
expertName: //专家名
position:"副主任医师" //职位
department: "儿科", //科室
id: //视点文章id
},
{
type:5 //类型:精彩活动
image: "http://www1.pcbaby.com.cn/03daodu.jpg",
url:// 活动页面url
},
{
type:6 //类型:资讯文章
image: "http://www1.pcbaby.com.cn/03daodu.jpg",
title: "孩子经常发烧怎么办?",
preview:"孩子经常发烧" //简介
articleId: "2042246" //文章id
},
{
type:7 //类型:百科文章
image: "http://www1.pcbaby.com.cn/03daodu.jpg",
title: "孩子经常发烧怎么办?",
preview:"孩子经常发烧" //简介
url: "http://baike.pcbaby.com.cn/app/zsd/1190.html" //百科文章url
},
{
type:8 //类型:生活圈帖子
image: "http://www1.pcbaby.com.cn/03daodu.jpg",
title: "孩子经常发烧怎么办?",
preview:"孩子经常发烧" //简介
topicId: 2155710, //帖子ID
},
{
type:9 //类型:私密圈帖子
image: "http://www1.pcbaby.com.cn/03daodu.jpg",//私密贴icon
title: "孩子经常发烧怎么办?",
preview:"孩子经常发烧" //简介
topicId: 2155710, //帖子ID
},
{
type:10 //类型:html页
image: "http://www1.pcbaby.com.cn/03daodu.jpg",
title: "孩子经常发烧怎么办?",
preview:"孩子经常发烧" //简介
url: "http://baike.pcbaby.com.cn/app/zsd/1190.html" //html页面url
},
}
],
topics:[ //精彩话题(生活圈与私密圈帖子一共出5条数据,两者出现的顺序与数目不固定,但总数目不变:5条)
{ //生活圈帖子
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"
],
image:"http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752585_1420975033163_1024x1024.jpg",//帖子导读图或第一张图
isSecret: false, //是否私密贴(false 生活贴;true 私密贴)
title: "超可爱萌妹子融化人心", //帖子标题
message: " 《雯雯 萌萌哒》超级可爱的萌妹子,完全可以萌化到心底里...", //帖子内容
topicId: 2155848, //帖子id
userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70", //用户头像
userId: 1265767, //用户ID
userName: "啃蘋果的壞蛋", //用户昵称
viewCount: 22, //帖子浏览数
replyCount: 2, //帖子回复数
}
...
{ //私密圈帖子
topicId: 2156386, //帖子ID
isSecret: true, //是否私密贴(false 生活贴;true 私密贴)
title: "最难忘前任的那点", //标题
message: "最难忘前任的那点", //帖子内容
createAt: "2015-01-12 14:34:15", //发帖时间
viewCount: 2, //帖子浏览数
replyCount: 0, //帖子回复数
}
...
]
topFocus: [ //焦点图广告
{
cc-uri: "",
image: "http://www1.pcbaby.com.cn/appguanggao/1.jpg?IVY_LEVEL_1?481456_307375",
seq: 1,
title: "广告",
to-uri: "http://ivy.pconline.com.cn/adpuba/click?adid=307375&id=test.gjz.zicong.",
updateAt: 1408678837215,
vc-uri: "none"
}
]
}
2.0 0~1岁育儿每日知识
备注:1岁~6岁育儿每日知识不变(继续使用2.3版本的育儿每日知识);
接口开发:
mrobot接口: http://mrobot.pcbaby.com.cn/s/qzbd/baike/timelineContentDay.xsp?v=240&lemmaId=41
后端URL: http://v40.pcbaby.com.cn:8001/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=13777 正式域名 baike.pcbaby.com.cn
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:有
缓存时间:1小时
请求参数:
参数名 类型 必须 说明 lemmaId string 是 时间轴id v string 是 版本号
返回参数:
{
ad:[ // 广告数据
{
"content": "",//广告内容
"url": "" //广告跳转url
}
],
cookbook:[ //今日食谱数据
{
"day": "第1天", //当前天数
"detail": [
{
"des": "薏米银耳羹", //食谱详情
"id": 21739, //食谱id
"image": "http://xxx", //食谱图片
"title": "银耳薏米汤" //食谱标题
},
{
"des": "宫寒会",
"id": 24339,
"image": "http://xxx",
"title": "饮食驱宫寒有助女性受孕"
}
]
}
],
"timeline": //每日知识内容
[
{
"section": [
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容
"description": "16周+1天胎儿发育精简16周+1天胎儿发育精简16周+1天胎儿发育精简16周+1天胎儿发育精简16周+1天胎儿发育",//内容描述(读取字段)
"id": 13948,
"image": "http://test745.pcbaby.com.cn:9192/upcfiles/baby_baike/1506/09/c0/17620_1433822772846.jpg",
"title": "16周+1天胎儿发育精简",
"type": "11"
}
],
"sectionListCount": 1,
"title": "发育指标"
},
{
"section": [
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容(读取字段)
"description": "16周+1天知识点1精简16周+1天知识点1精简16周+1天知识点1精简16周+1天知识点1精简16周+1天知识点1精简",
"id": 13949,
"image": "http://test745.pcbaby.com.cn:9192/upcfiles/baby_baike/1506/09/c0/17621_1433822818887.jpg",
"title": "16周+1天知识点1精简",
"type": "11"
},
{
"content": "现在子宫和胎盘一直挤压我的小脸,但不会痛哦。另外,我的眼睛可以辨认颜色啦。", //精简内容(读取字段)
"description": "16周+1天知识点2精简16周+1天知识点2精简16周+1天知识点2精简16周+1天知识点2精简16周+1天知识点2精简",
"id": 13950,
"title": "16周+1天知识点2精简",
"type": "11"
}
],
"sectionListCount": 2,
"title": "每日知识"
}
]
}
2.1分享页面接口
备注:分享出去的页面必须能区分打开的设备
接口地址:育儿 http://www1.pcbaby.com.cn/app/201507/v2_4/share_ye.html
怀孕 http://www1.pcbaby.com.cn/app/201507/v2_4/share_hy.html
备孕 http://www1.pcbaby.com.cn/app/201507/v2_4/share_by.html
HTTP请求方式:get
是否需要登录:否
返回格式:html
缓存方式:无缓存
缓存时间:无
请求参数: v = 240 版本号,有可能不同版本的分享页面不同
3.0 帖子终端页和活动终端页
备注:在圈子栏目或者活动栏目打开帖子终端页,需要支持打开外链
接口开发:
帖子终端页url: http://mrobot.pcbaby.com.cn/v2/bbs/topics/2992675?pageNo=1&size=17&picRule=2&v=230&newQuote=true
帖子终端页后端接口url: http://bbs.pcbaby.com.cn/rest/topics/2992675
活动终端页url: http://play9.pcbaby.com.cn/baby140801/baby/mryq.jsp?fromapp
4.0 资讯文章终端页优化
备注:目前的资讯文章终端页太大,拆分成css、js和html主体两个部分,其中css、js放客户端本地,html主体由mrobot接口给出;客户端需支持在线更新css、js功能
资源更新配置地址:pcbaby_android_auto_update.json、pcbaby_iphone_auto_update.json
请求参数:新增如下请求参数platform 平台标识。android平台,platform=android;ios平台,platform=ios
v=240 版本号
resVer 资源包版本号。resVer=24001,此版本号由app版本号和资源包迭代版本构成,如资源包第一版,resVer=24001;资源包第二版,resVer=24002,如此类推
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)