wiki:baby2.2_developers/interface

Version 14 (modified by lianchijin, 11 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

二.接口列表

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:未解决数量
  }

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 私语列表
  备注:获取私密圈私语列表
  接口开发:丁健勇
  mrobot接口URL:
  后端接口URL:
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:
  请求参数:
  pageNo:1 //页码
  pageSize:20 //每页条数
  v = 2.2  //版本号
  
  返回参数,成功:
 {
  pageNo: 1,    //页码
  pageSize: 20, //每页条数
  total: 15163, //总数量
  topics: [
    {  //普通列表数据
      topicId: 2156386,          //帖子ID
      title: "最难忘前任的那点",    //标题
      message: "有没有姐妹满月了就同房的呀,老公都憋了几个月了,呵呵", //帖子内容
      createAt: "2015-01-12 14:34:15",    //发帖时间
      viewCount: 2,  //帖子浏览数 
      replyCount: 0  //帖子回复数
    },
    {  //推广位——话题贴
      topicId: 2156386,        //帖子ID
      title: "最难忘前任的那点", //标题
      message: "有没有姐妹满月了就同房的呀,老公都憋了几个月了,呵呵", //帖子内容
      createAt: "2015-01-12 14:34:15", //发帖时间
      viewCount: 2,  //帖子浏览数
      replyCount: 0, //帖子回复数
      recommendType: 1, //推广位类型:1=话题贴;2=私密贴;3= 话题引导贴
    },
    {  //推广位——私密贴
      topicId: 2156386,        //帖子ID
      title: "最难忘前任的那点", //标题
      message: "有没有姐妹满月了就同房的呀,老公都憋了几个月了,呵呵", //帖子内容
      createAt: "2015-01-12 14:34:15", //发帖时间
      viewCount: 2,  //帖子浏览数
      replyCount: 0, //帖子回复数
      recommendType: 2, //推广位类型:1=话题贴;2=私密贴;3= 话题引导贴(int类型)
      tagName: "杜蕾斯专场"  //专场标签(string类型)
      guestName: "毒舌辣妈" //特邀嘉宾标签 (string类型)
    },
    {  //推广位——话题引导
      topicId: 2156386, //帖子ID
      message: "当面对的是生活是柴米油盐", //引导话题贴内容
      recommendType: 3, //推广位类型:1=话题贴;2=私密贴;3= 话题引导贴(int类型)
    }
  ],
 
}