wiki:baby2.7_developers/interface

Version 18 (modified by fuxingfang, 10 years ago) (diff)

--

一.基本约定

  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首页

(mrobot已完成开发,请连开发机进行测试)

1)mrobot接口url:

备孕首页: http://mrobot.pcbaby.com.cn/v2/qzbd/home/1?v=270

2)后端接口:

推荐内容: http://www.pcbaby.com.cn/app/qzbd2/yesy/yejson/1507/intf6922.js
精彩话题: http://bbs.pcbaby.com.cn/mobile/v2_3/getWonderfulTopic.do?homePosition=rearindex&agent=2
每日知识: http://baike.pcbaby.com.cn/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=14858


HTTP请求方式:get
是否需要登录:否
返回格式:JSON
是否有缓存:有
缓存时间:15分钟
请求参数:

参数名类型必须说明
idstring栏目id
vstring版本号,即:270
lemmaIdstring时间轴id
agentstring客户端标识,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": {
//1-2岁每日知识内容,根据时间轴id,一次性返回7条数据(1-12个月,每个月返回的7条数据都不同);
//2-6岁每日知识内容,根据时间轴id,一次性返回7条数据(2-6岁,每年返回7条数据)
//0-1岁保持原来的,每天返回一条数据(兼容旧版本)

    "point": [
      [ //知识点概括
        {
             "content": "现在子宫和胎盘一直挤压我的小脸。",
             "description": "进入孕后期",
             "id": 511,
             "title": "孕妇尿频",
             "type": "11"
        },
        {
             "content": "现在子宫和胎盘一直挤压我的小脸。",             "description": "孕期气短通常没有什么大碍。",
             "id": 633,
             "title": "孕妇气短",
             "type": "11"
        }
      ],
     [ //知识点概括
        {
             "content": "现在子宫和胎盘一直挤压我的小脸。",
             "description": "进入孕后期。",
             "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: (推荐位)
//(1-2岁育儿,根据时间轴id,一次性返回31条数据) 
//(2-6岁育儿,根据时间轴id,一次性返回31条数据)
//(0-1岁育儿,跟旧版保持不变,每天返回一条数据,考虑旧版本兼容)
[ 
   {
     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
  }
 ],
 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岁育儿每日知识

(mrobot已完成开发,请连开发机进行测试)

备注:


1-2岁,12个节点,每日知识内容要根据不同节点变化,一次性返回7条数据;
2-6岁,5个节点,每日知识内容要根据不同节点变化,一次性返回7条数据;
0-1岁,保持旧版本即可,每天返回一条数据(注意版本兼容)


接口开发:
mrobot接口: http://mrobot.pcbaby.com.cn/s/qzbd/baike/timelineContentDay.xsp?v=240&lemmaId=41
后端接口: http://baike.pcbaby.com.cn/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=14858 正式域名 baike.pcbaby.com.cn
HTTP请求方式:get
是否需要登录:否
返回格式:JSON
缓存方式:有
缓存时间:1小时
请求参数:

参数名类型必须说明
lemmaIdstring 时间轴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": "饮食驱宫寒有助女性受孕"
	      }
         ]
       },
    {
       
          "day": "第2天", //当前天数
          "detail": [
            {
		"des": "薏米银耳羹", //食谱详情
		"id": 21739,  //食谱id
		"image": "http://xxx", //食谱图片
		"title": "银耳薏米汤" //食谱标题
           }, 
           {
		"des": "宫寒会",
		"id": 24339,
		"image": "http://xxx",
		"title": "饮食驱宫寒有助女性受孕"
	    }
         ]
    }
}
   ],
   "timeline": //每日知识内容
   [
    {
     "section": [
                {
                    "content": "现在子宫和。", //精简内容(读取字段)
                    "description": "16周+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",
                    "id": 13950,
                    "title": "16周+1天知识点2精简",
                    "type": "11"
                }
            ],
            "sectionListCount": 2,
            "title": "每日知识"
},
{
 "section": [
        {
            "section": [
                {
                    "content": "现在子宫", //精简内容(读取字段)
                    "description": "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",
                    "id": 13950,
                    "title": "16周+1天知识点2精简",
                    "type": "11"
                }
            ],
            "sectionListCount": 2,
            "title": "每日知识"
 }
  ]
 }

3.0 活动终端页:(url增加内容描述字段)


 http://m.pcbaby.com.cn/bbs/topic-3269144.html?fromPcbabyApp&fromapp&title=“标题”&desc=“优惠活动等着你,优惠活动等着你,优惠活动等着你

4.0 服务协议wap页

(mrobot已完成开发,请连开发机进行测试)

mrobot接口

 http://mrobot.pcbaby.com.cn/s-86400/qzbd/cms/protocol.xsp

后端接口

后端接口文档

说明

太平洋网络服务条款及使用协议

缓存时间

24h

提交方式

GET

是否需要登录

参数

参数名 参数含义 类型 默认值 是否必须 备注

返回格式

html

返回数据

html页面


5.0举报wap页


mrobot接口

后端接口

后端接口文档

说明

太平洋网络服务条款及使用协议

缓存时间

提交方式

POST

是否需要登录

参数

参数名 类型 必须 说明
isBBSstring判断举报是否来自帖子终端页,isBBS=1时来自帖子;isBBS=0时来自文章
topicIdstring帖子id或文章id
postIdstring楼层id,当举报来自文章评论时postId=0

返回格式

html

返回数据

html页面


Attachments