Changes between Initial Version and Version 1 of baby3.0_developers/interface

Timestamp:

02/16/2016 03:46:14 PM (10 years ago)

Author:

zengwenjie

Comment:

--

baby3.0_developers/interface

@@ +1 @@
+[[TOC]]
+
+== 一.基本约定 ==
+
+{{{
+  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.首页接口调整==
+ **说明：**
+  >首页旧接口调整
+ **开发人员：**
+  >mrobot ,少凡
+ **HTTP请求方式：**
+  >get
+ **是否需要登录：**
+  >否
+ **返回格式：**
+  >JSON
+ **缓存方式：**
+  >有
+ **缓存时间：**
+  >无
+ **请求参数**
+ ||参数名||类型||必须||说明||
+ ||id ||int ||不是 ||栏目id ||
+ ||v ||int ||不是 ||版本号) ||
+ || lemmaId ||int ||是 ||时间轴id） ||
+ || agent ||int ||是 ||客户端标识，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，不需要时为空字符串)
+    }
+  ],
+//新增推荐位,根据时间节点一天返回3套数据，一套3条数据
+ "recommendTimeline": [
+{
+        "index": [
+            {
+                "content": "新生儿一天要睡20-22个小时，脸上还会有不同的表情。",
+                "description": "\n出生后,在这期间大约有9-10个小时是浅睡眠状态,因而新生儿睡觉大多不踏实。",
+                "id": 15403,
+                "image": "http://www1.pcbaby.com.cn/baby/4.jpg",
+                "title": "发育指标",
+                "type": 内容类型（type=1 图集，type=2 视频，type=3 专家视点，type=4 问答专栏（已去除），type=5 精彩活动，type=6 资讯文章，type=7 百科文章，type=8 生活圈帖子，type=9 私密圈帖子，type=10 html页）
+
+            }
+        ],
+        "point": [
+            {
+                "content": "物理按摩、中药、快速下奶。",
+                "description": "对新妈妈来豆味。杂粮粥营养价值高，不仅可以补养身体，还可以促进乳汁分泌。",
+                "id": 15775,
+                "title": "吃什么下奶",
+                "type": "11"
+            },
+            {
+                "content": "新生儿吐奶后，妈妈要把他要减少到平时的一半，缓解吐奶症状。",
+                "description": "吐奶是新生儿的常见现象，，也可能是身查明原因。",
+                "id": 16147,
+                "title": "新生儿吐奶怎么办",
+                "type": "11"
+            }
+        ]
+    },    
+{
+
+},
+{
+
+}
+
+  ],
+
+ "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.验证序列号是否有效接口==
+
+ **说明：**
+ >验证序列号是否有效接口
+ **开发人员：**
+ >李峰
+ ** HTTP请求方式：**
+ >post
+ **是否需要登录：**
+ >是
+ **返回格式：**
+ >JSON
+ **缓存方式：**
+ >无
+ **缓存时间：**
+ >无
+ **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||登录用户id ||
+ || serial_no ||string ||是 ||系列号 ||
+ || type ||int ||是 ||设备种类（1：胎语仪，2：体重秤） ||
+
+{{{
+  返回参数:
+{
+        “status”：0,                     //处理状态
+        “message”："序列号正确！" //相关状态信息
+ }
+
+}}}
+
+
+==  3.激活设备序列号:==
+  **开发人员**
+  >（ 李峰）
+  **HTTP请求方式：**
+  >post
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+ || phone_number ||string ||是 ||手机号||
+ || serial_no ||string ||是 ||系列号||
+ || type ||int ||是 ||设备种类（1：胎语仪，2：体重秤）||
+
+{{{
+  返回参数:
+返回(json格式)：
+{
+        “status”：0,                     //处理状态
+        “message”："序列号正确！" //相关状态信息
+ }
+
+}}}
+
+== 4.找回序列号: ==
+  **开发人员**
+  >（ 李峰）
+  **HTTP请求方式：**
+  >post
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+ || phoneNum ||string ||是 ||手机号||
+ || type ||int ||是 ||设备种类（1：胎语仪，2：体重秤）||
+
+{{{
+  返回参数:
+返回(json格式)：
+{
+        “status”：0,                     //处理状态
+        “message”："已发送系列号到手机" //相关状态信息
+}
+
+}}}
+
+== 5. 保存（备份）记录 (后端，要参考快妈接口 ):==
+  **开发人员**
+  >（ 李峰）
+  **HTTP请求方式：**
+  >post
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+ || lemaId ||int ||是 ||时间轴id||
+ || height ||float ||不是 ||身高||
+ || beforeWeight ||float ||不是 ||孕前体重||
+ || weight ||float ||是 ||当前体重||
+ || babyWeight ||float ||不是 ||婴儿体重||
+ || date ||string ||不是 ||当天日期（2016-05-02）||
+
+{{{
+  返回参数:
+{
+    “status”：0,（0代表成功，-1代表失败）   //处理状态
+  “message”： （描述信息）,
+   “height”:  175, (身高，可以为空)
+  “beforeWeight”:50.0 （孕前体重，可以为空）
+}
+
+}}}
+
+== 6. 体重分析wap页面: ==
+  **开发人员**
+  >mrobot，制作
+  **HTTP请求方式：**
+  >get
+  **是否需要登录：**
+  >否
+  **返回格式：**
+  >html页面
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || lemaId ||int ||是 ||时间轴id||
+ || height ||float ||不是 ||身高||
+ || beforeWeight ||float ||不是 ||孕前体重||
+ || weight ||float ||是 ||当前体重||
+ || date ||string ||是 ||当天日期（2016-05-02）||
+
+== 7. 上传胎心记录接口: ==
+  **开发人员**
+  >（ 李峰）
+  **HTTP请求方式：**
+  >post
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+ || averageRate ||int ||是 ||平均心率||
+ || recodeTime ||string ||是 ||录制时长||
+ || lemenId ||int ||是 ||时间轴id||
+ || weight ||float ||是 ||当前体重||
+ || recodeData ||data ||是 ||音频文件||
+ || date ||string ||不是 ||2013-8-3 15:30:25（精确到秒）||
+
+{{{
+  返回参数:
+{
+    “status”：0,（0代表成功，-1代表失败）   //处理状态
+  “message”： （描述信息）,
+}
+
+}}}
+
+== 8. 获取孕周和体重记录: ==
+  **开发人员**
+  >mrobot ,李峰
+  **HTTP请求方式：**
+  >get
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+
+{{{
+  返回参数:
+ {
+          “status”:(0正常，-1异常)
+        "msg":"数据获取成功" //提示信息
+        "BMIType":4 //BMI指数类型（4孕前正常，5孕前偏瘦，6孕前偏重，7孕前超重)
+        "data": [
+            {
+                  "lemmaId": 281, //时间节点id
+                  “date”:2016-05-01,
+                     "weight": 58.0, // 体重
+                      “desc” :”偏重”
+            },
+            {
+                    "lemmaId": 282, //时间节点id
+                  “date”:2016-05-01,
+                    "weight": 59.0 // 体重
+                     “desc” :”偏轻”
+            }
+            ...
+         ]
+ }
+
+}}}
+
+== 9. 胎语纪录分析页，推荐内容接口: ==
+  **开发人员**
+  >mrobot ,制作
+  **HTTP请求方式：**
+  >get
+  **是否需要登录：**
+  >否
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || date ||string ||是 ||当前日期（2016-3-30）||
+ ||  v  ||string ||不是 ||版本号（300）||
+
+{{{
+  返回参数:
+{
+  status : (0代表正常，-1代表异常)
+data:[
+ {
+   id:”198”,
+   imgUrl:””,
+   title:”宝宝心跳，带给孕妈的感动”,
+  desc: “”
+ },
+ {
+  id:201
+  title: “”
+ },
+ {
+  id:202
+  title:””
+ }
+ ]
+ }
+}}}
+
+== 10.获取我的记录接口: ==
+  **开发人员**
+  >mrobot ,李锋
+  **HTTP请求方式：**
+  >get
+  **是否需要登录：**
+  >是
+  **返回格式：**
+  >JSON
+  **缓存方式：**
+  >无
+  **缓存时间：**
+  >无
+  **请求参数：**
+ ||参数名||类型||必须||说明||
+ || common_session_id ||string ||是 ||用户id||
+ ||  v  ||string ||不是 ||版本号（300）||
+
+{{{
+  返回参数:
+{
+  "pageNo": 1,
+  "pageSize": 20,
+  "record": [
+    {
+      "data": “2016-2-2”,
+      "weight": "59.0kg",
+      "weightState": "体重正常",
+      "tip": “专家提醒：良好的生活习惯继续保持。进行有效的锻炼，有助于孕妇控制体重",
+      time:”2016-2-15 15:30:25” (保存胎语记录时间)
+      "heartBeat": “110～160次/分”,（怀孕阶段才出来）
+       “babyWeight” : 10 (婴儿体重)
+       “babyState” :   “正常体重”
+      "heartState": “正常" 
+    },
+    {
+      "data": “2016-2-2”,
+      "weight": "59.0kg",
+      "weightState": "体重正常",
+      "tip": “专家提醒：良好的生活习惯继续保持。进行有效的锻炼，有助于孕妇控制体重",
+       time:”2016-2-15 15:30:25” (保存胎语记录时间)
+      "heartBeat": “110～160次/分",
+       “babyWeight” : 10 (婴儿体重)
+       “babyState” :   “正常体重”
+      "heartState": "正常"
+}
+......
+  ],
+  "total": 100
+}
+}}}