Changes between Version 2 and Version 3 of baby2.7_developers/interface


Ignore:
Timestamp:
10/20/2015 09:20:02 AM (10 years ago)
Author:
zengwenjie
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • baby2.7_developers/interface

    v2 v3  
     1[[TOC]] 
     2 
     3== 一.基本约定 == 
     4 
     5{{{ 
     6  1.开发机、测试机代理地址： 
     7  mrobot开发机代理：192.168.10.199  端口：1080 
     8  mrobot测试机代理：192.168.10.198  端口：1080 
     9   
     10  2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     11   
     12  3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 
     13      { 
     14         "desc":"给用户的提示放在这里" 
     15      } 
     16       
     17  4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 
     18   
     19  5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     20   
     21  6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 
     22   
     23  7.需要分页的接口，统一返回以下字段:  pageNo,pageSize,total 
     24   
     25  8.涉及接口都需要传请求参数：v = 240  //版本号(数字) 
     26 
     27}}} 
     28 
     29== 二.接口列表 == 
     30=== 1.0首页 === 
     31  技术：郑少凡（接口）、黄平（论坛）、吴全贵（百科） 
     32  1)mrobot接口url： 
     33     备孕首页：http://mrobot.pcbaby.com.cn/v2/qzbd/home/1?v=270 
     34 
     35  2）后端接口： 
     36     [[BR]]推荐内容：http://www.pcbaby.com.cn/app/qzbd2/yesy/yejson/1507/intf6922.js# 
     37     [[BR]]精彩话题：http://bbs.pcbaby.com.cn/mobile/v2_3/getWonderfulTopic.do?homePosition=rearindex&agent=2 
     38     [[BR]]每日知识：http://baike.pcbaby.com.cn/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=14858 
     39 [[BR]]HTTP请求方式：get 
     40 [[BR]] 是否需要登录：否 
     41 [[BR]]返回格式：JSON 
     42 [[BR]]是否有缓存：有 
     43 [[BR]]缓存时间：15分钟 
     44 [[BR]]请求参数： 
     45 ||参数名||类型||必须||说明|| 
     46 ||id||string||是||栏目id|| 
     47 ||v||string||是||版本号，即：270||  
     48 ||lemmaId||string||是||时间轴id|| 
     49 ||agent||string||是||客户端标识，IOS：2，Android：3|| 
     50   
     51 {{{ 
     52  返回参数: 
     53 { 
     54  extend:[  //推广的文字链，文字链只分阶段不分时间轴，如果没有则返回空 
     55    { 
     56      title:"这里是文字链啊，分阶段不分时间轴，这个文字链的文字客户端一定要分行显示完整啊囧，不完整不行啊", 
     57      url:"http://www.baidu.com", 
     58    } 
     59  ], 
     60  focus:[  //焦点图数据 
     61    { 
     62      id:  //  id："articleId=234&expertId=112&num=111"（  推“专栏详情”的推广时id为文章id&专家id&专栏期数id） 
     63      image: 
     64      title: 
     65      type:论坛（1列表、2终端）；亲子学院（3列表、4终端）；活动（5列表、6终端）；工具（7终端）；食谱（8终端）；资讯（9终端）； 
     66           问答（10终端）；百科（11终端）；崔玉涛视频（12视频文章终端）；专栏详情（13） 
     67      url:(活动、工具终端打开需要url，不需要时为空字符串) 
     68    } 
     69  ], 
     70 "timeline": [ 
     71  //1-2岁每日知识内容，根据时间轴id,一次性返回7条数据（1-12个月，每个月返回的7条数据都不同）； 
     72 //2-6岁每日知识内容，根据时间轴id,一次性返回7条数据（2-6岁，每年返回7条数据） 
     73//0-1岁保持原来的，每天返回一条数据（兼容旧版本） 
     74 
     75      [ //知识点概括 
     76        { 
     77             "content": "现在子宫和胎盘一直挤压我的小脸。", 
     78             "description": "进入孕后期", 
     79             "id": 511, 
     80             "title": "孕妇尿频", 
     81             "type": "11" 
     82        }, 
     83        { 
     84             "content": "现在子宫和胎盘一直挤压我的小脸。",             "description": "孕期气短通常没有什么大碍。", 
     85             "id": 633, 
     86             "title": "孕妇气短", 
     87             "type": "11" 
     88        } 
     89      ], 
     90     [ //知识点概括 
     91        { 
     92             "content": "现在子宫和胎盘一直挤压我的小脸。", 
     93             "description": "进入孕后期。", 
     94             "id": 511, 
     95             "title": "孕妇尿频", 
     96             "type": "11" 
     97        }, 
     98        { 
     99             "content": "现在子宫", 
     100             "description": "孕期气短通常没有什么大碍。", 
     101             "id": 633, 
     102             "title": "孕妇气短", 
     103             "type": "11" 
     104        } 
     105      ] 
     106  ], 
     107  recommendChannel:[ //热门栏目 
     108   { 
     109     title:  //根据栏目名称跳转至对应模块 
     110     type:  //热门栏目类型（type＝5表示家庭育儿） 
     111            //type=1 阅读，type=2 百科，type=3 交流圈，type=4 每日知识，type=5 家庭育儿，type=6 问答，type=7 活动，type=8 工具，type=9 每日食谱     
     112   } 
     113  ], 
     114 recommendContent: （推荐位） 
     115//（1-2岁育儿，根据时间轴id，一次性返回31条数据）  
     116//（2-6岁育儿，根据时间轴id，一次性返回31条数据） 
     117//（0-1岁育儿，跟旧版保持不变，每天返回一条数据，考虑旧版本兼容） 
     118[  
     119   { 
     120     type:1 //类型：图集；内容类型（type=1 图集，type=2 视频，type=3 专家视点，type=4 问答专栏（已去除），type=5 精彩活动，type=6 资讯文章，type=7 百科文章，type=8 生活圈帖子，type=9 私密圈帖子，type=10 html页） 
     121     image: //图片url 
     122     title: //标题 
     123     imageCount:13 //图集总数 
     124     albumsId:  //图集id 
     125     label:"宝宝护理" //图集标签 
     126   }, 
     127   { 
     128     type:2 //类型：视频 
     129     image: //图片url 
     130     title: //标题 
     131     preview:"孩子经常发烧" //简介  
     132     articleId: "2042246", //文章id 
     133     videoId: "2006"， //视频id 
     134   }, 
     135   { 
     136     type:3 //类型：专家视点 
     137     image: //图片url 
     138     title: //标题 
     139     url:  //专家视点页面url 
     140     expertName: //专家名 
     141     position:"副主任医师" //职位 
     142     department: "儿科"， //科室 
     143     id:  //视点文章id 
     144  } 
     145 ], 
     146 topics:[ //精彩话题（生活圈与私密圈帖子一共出5条数据，两者出现的顺序与数目不固定，但总数目不变：5条） 
     147（每日更新内容，不以时间节点为单位） 
     148   { //生活圈帖子 
     149     createAt: "2015-01-11 19:30:35", //帖子的创建时间 
     150     images: [ //帖子图片组成的数组 
     151       "http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752585_1420975033163_1024x1024.jpg", 
     152       "http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752586_1420975112551_1024x1024.jpg", 
     153       "http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752588_1420975163834_1024x1024.jpg" 
     154     ], 
     155     image："http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c1/1752585_1420975033163_1024x1024.jpg",//帖子导读图或第一张图 
     156     isSecret: false, //是否私密贴（false 生活贴；true 私密贴） 
     157     title: "超可爱萌妹子融化人心", //帖子标题 
     158     message: " 《雯雯 萌萌哒》超级可爱的萌妹子，完全可以萌化到心底里...", //帖子内容 
     159     topicId: 2155848, //帖子id 
     160     userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70", //用户头像 
     161     userId: 1265767, //用户ID 
     162     userName: "啃蘋果的壞蛋", //用户昵称 
     163     viewCount: 22, //帖子浏览数 
     164     replyCount: 2, //帖子回复数 
     165   } 
     166   ... 
     167   {  //私密圈帖子 
     168     topicId: 2156386,          //帖子ID 
     169     isSecret: true, //是否私密贴（false 生活贴；true 私密贴） 
     170     title: "最难忘前任的那点",    //标题 
     171     message: "最难忘前任的那点", //帖子内容 
     172     createAt: "2015-01-12 14:34:15",    //发帖时间 
     173     viewCount: 2,  //帖子浏览数  
     174     replyCount: 0,  //帖子回复数 
     175   } 
     176   ... 
     177 ] 
     178 topFocus: [ //焦点图广告 
     179   { 
     180     cc-uri: "", 
     181     image: "http://www1.pcbaby.com.cn/appguanggao/1.jpg?IVY_LEVEL_1?481456_307375", 
     182     seq: 1, 
     183     title: "广告", 
     184     to-uri: "http://ivy.pconline.com.cn/adpuba/click?adid=307375&id=test.gjz.zicong.", 
     185     updateAt: 1408678837215, 
     186     vc-uri: "none" 
     187   } 
     188  ] 
     189 } 
     190 }}} 
     191 
     192=== 2.0 0~1岁育儿每日知识 === 
     193百科开发：吴全贵；mrobot开发：傅兴方 
     194  备注： 
     195//1-2岁，12个节点，每日知识内容要根据不同节点变化，一次性返回7条数据； 
     196//2-6岁，5个节点，每日知识内容要根据不同节点变化，一次性返回7条数据； 
     197//0-1岁，保持旧版本即可，每天返回一条数据（注意版本兼容） 
     198 
     199  [[BR]]接口开发: 
     200  [[BR]]mrobot接口： http://mrobot.pcbaby.com.cn/s/qzbd/baike/timelineContentDay.xsp?v=240&lemmaId=41 1 
     201  [[BR]]后端接口：http://baike.pcbaby.com.cn/intf/app/2.0/timeline_content_list_301.jsp?lemmaId=14858    //正式域名 baike.pcbaby.com.cn 
     202  [[BR]]HTTP请求方式：get 
     203  [[BR]]是否需要登录：否 
     204  [[BR]]返回格式：JSON 
     205  [[BR]]缓存方式：有 
     206  [[BR]]缓存时间：1小时 
     207  [[BR]]请求参数： 
     208 ||参数名||类型||必须||说明|| 
     209 ||lemmaId||string ||是 ||时间轴id || 
     210 ||v ||string ||是 ||版本号 || 
     211 
     212{{{ 
     213  返回参数: 
     214 { 
     215  { 
     216   ad:[  // 广告数据 
     217     { 
     218        "content": "",//广告内容 
     219        "url": "" //广告跳转url 
     220     } 
     221     ],  
     222   cookbook:[  //今日食谱数据 
     223        { 
     224          "day": "第1天", //当前天数 
     225          "detail": [ 
     226            { 
     227                "des": "薏米银耳羹", //食谱详情 
     228                "id": 21739,  //食谱id 
     229                "image": "http://xxx", //食谱图片 
     230                "title": "银耳薏米汤" //食谱标题 
     231           },  
     232           { 
     233                "des": "宫寒会", 
     234                "id": 24339, 
     235                "image": "http://xxx", 
     236                "title": "饮食驱宫寒有助女性受孕" 
     237              } 
     238         ] 
     239       }, 
     240    { 
     241        
     242          "day": "第2天", //当前天数 
     243          "detail": [ 
     244            { 
     245                "des": "薏米银耳羹", //食谱详情 
     246                "id": 21739,  //食谱id 
     247                "image": "http://xxx", //食谱图片 
     248                "title": "银耳薏米汤" //食谱标题 
     249           },  
     250           { 
     251                "des": "宫寒会", 
     252                "id": 24339, 
     253                "image": "http://xxx", 
     254                "title": "饮食驱宫寒有助女性受孕" 
     255            } 
     256         ] 
     257    } 
     258} 
     259   ], 
     260   "timeline": //每日知识内容 
     261   [ 
     262    { 
     263     "section": [ 
     264                { 
     265                    "content": "现在子宫和。", //精简内容（读取字段） 
     266                    "description": "16周+1天知识点", 
     267                    "id": 13949, 
     268                    "image": "http://test745.pcbaby.com.cn:9192/upcfiles/baby_baike/1506/09/c0/17621_1433822818887.jpg", 
     269                    "title": "16周+1天知识点1精简", 
     270                    "type": "11" 
     271                }, 
     272                { 
     273                    "content": "现在子宫和胎盘", //精简内容（读取字段） 
     274                    "description": "16周+1", 
     275                    "id": 13950, 
     276                    "title": "16周+1天知识点2精简", 
     277                    "type": "11" 
     278                } 
     279            ], 
     280            "sectionListCount": 2, 
     281            "title": "每日知识" 
     282}, 
     283{ 
     284 "section": [ 
     285        { 
     286            "section": [ 
     287                { 
     288                    "content": "现在子宫", //精简内容（读取字段） 
     289                    "description": "16周+1天知识点1精简", 
     290                    "id": 13949, 
     291                    "image": "http://test745.pcbaby.com.cn:9192/upcfiles/baby_baike/1506/09/c0/17621_1433822818887.jpg", 
     292                    "title": "16周+1天知识点1精简", 
     293                    "type": "11" 
     294                }, 
     295                { 
     296                    "content": "现在子宫和胎盘一直挤压我的小", //精简内容（读取字段） 
     297                    "description": "16周+1天知识点2", 
     298                    "id": 13950, 
     299                    "title": "16周+1天知识点2精简", 
     300                    "type": "11" 
     301                } 
     302            ], 
     303            "sectionListCount": 2, 
     304            "title": "每日知识" 
     305 } 
     306  ] 
     307 } 
     308}}} 
     309 
     310== 活动终端页：(url增加内容描述字段) == 
     311 
     312论坛开发：黄平 
     313[[BR]]http://m.pcbaby.com.cn/bbs/topic-3269144.html?fromPcbabyApp&fromapp&title=%E3%80%90%E4%BA%B2%E5%AD%90%E5%AE%9D%E5%85%B8%E7%8C%9C%E8%B0%9C%E4%BC%9A%E3%80%91%E4%B8%AD%E7%A7%8B%E6%B4%BB%E5%8A%A8%E8%8E%B7%E5%A5%96%E5%90%8D%E5%8D%95%E5%85%AC%E5%91%8A&desc=“优惠活动等着你,优惠活动等着你,优惠活动等着你”