wiki:baby2.8_developers/interface

Version 12 (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 注册登录,验证码,重置密码,绑定手机相关接口地址:(旧接口)

trac地址: http://rdtrac.pc.com.cn/passport/wiki/API使用

== 2.保存状态接口:(备注:备孕,怀孕,育儿等状态)(新接口)==

说明:

保存用户状态数据

开发人员:

个人中心(李峰)

HTTP请求方式:

post

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数

参数名类型必须说明
common_session_id string 登录用户id
type int (0:代表备孕,1代表怀孕,2代表育儿)
childState int (1代表一胎,2代表二胎)
date1 string 日期(备孕日期,怀孕日期,育儿日期)
date2 string 大宝生日(备注:二胎才需要)
  返回参数:
{
  "status": 0,(0正常,-1异常)
}

== 3.获取状态接口:(备注:备孕,怀孕,育儿等状态)(新接口)==

说明:

获取用户状态数据

开发人员:

个人中心(李峰)

HTTP请求方式:

get

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
common_session_id string 登录用户id
  返回参数:
{
  "status": 0,(0正常,-1异常)
  type:(0:代表备孕,1代表怀孕,2代表育儿)
  childState:(1代表一胎,2代表二胎)
  date1:“2015.12.1”(备孕日期,怀孕日期,育儿日期)
 date2:“2013.10.2”(大宝生日)(备注:二胎才需要返回)
}

== 4.账号有效验证接口:(新接口)==

开发人员:passport

( 陈喆晖)

HTTP请求方式:

post

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
account string 输入账号内容
  返回参数:
{
  "status": 0,(0正常,-1异常)
“type”:(0:未注册,1:手机号,2:邮箱(备注:如果已注册直接发送重置密码邮箱))
  "message": “该账号还未注册哦~”(提示信息)
}

5.主贴、回帖、问答数目(新接口)

说明:

获取主贴,回帖,问答数目

开发人员:

mrobot,论坛,快问

HTTP请求方式:

get

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id

返回参数

  {
  topicCount:主帖数量
  askCount:问答数量
  replyCount:回帖数量
  }

6.我的发表-主贴、回帖、问答(新接口)

备注: 说明:

获取三个tab对应的列表数据

开发人员:

mrobot,论坛(黄平),快问

HTTP请求方式:

get

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id
type int (1代表主贴,2代表回帖,3代表问答)
pageNo string 当前第几页
pageSize string 每页显示的数量

返回参数

  type为1时的返回参数,成功时:
  {
   status: (0:成功,-1失败)
   desc: "查询成功",
   uid: 用户id,
   topics:[
    {
       topicId: 主帖,
       type: 0 普通帖子,1精华帖子,
       title: 标题,
       createAt: 发帖时间,
       secretForum:(0为生活贴,1 为私密帖)
    }
   ]
  }
 
 type为2时的返回参数,成功时:
  {
   status: (0:成功,-1失败),
   desc: "查询成功",
   uid: 用户id,
   topics:[
    {
       topicId: 主帖id,
       image: 主帖中的第一张图片,
       title: 主帖标题,
       authorName: 主帖的用户名,
       createAt: 主帖创建时间,
       secretForum:(0为生活贴,1 为私密帖),
       replyContent: 回帖的内容,
       toReplyContent:引用回帖的内容(当回复是回帖的回复时,该参数不为空)
       replyAuthorName: 回帖的用户名,
       replyAuthorId: 回帖的用户id,
       replyTime: 回帖的时间
    }
   ]
  }
 
  type为3时的返回参数,成功时:
  {
   status: (0:成功,-1失败),
   desc: "查询成功",
   uid: 用户id,
   topics:[
    {
       id:461751,
       type: 0 未解决的问题, 1 已解决的问题
       title: 标题,
       date:“2015-12-4” //日期
    }
   ]
  }

7.我的关注接口(新接口)

开发人员:

mrobot,个人中心(李峰),论坛

HTTP请求方式:

get

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id
pageNo string 当前第几页
pageSize string 每页显示的数量

返回参数

  {
   status: (0:成功,-1失败),
   desc: "查询成功",
   uid: 用户id, 
   topics:[
    {
      userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/12/65/76/7/1265767_70x70", //用户头像
      userId: 1265767, //用户ID
      userName: "啃蘋果的壞蛋", //用户昵称
     newTitles:[
	    {
         topicId: 主帖id,
         title: 标题,
	 },
 	   {
         topicId: 主帖id,
         title: 标题,
	 }
	   ]
    }
   ]
  total: 639 //总条数
  }

8.取消关注接口:(新接口)

(后端接口已完成)
线上接口: http://my.pcbaby.com.cn/intf/forApp/cancel_follow.jsp
测试接口: http://v11.pcbaby.com.cn:82/intf/forApp/cancel_follow.jsp
HTTP请求方式:

post

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id

返回参数

  {
   msg:    //提示信息
   result:  //1:取消关注成功;  0:该关注不存在或已取消关注
   pointCount:“点赞数”,
  }

9.点赞关注接口:(新接口))

(后端接口已完成)
线上接口: http://my.pcbaby.com.cn/intf/forApp/follow.jsp
测试接口: http://v11.pcbaby.com.cn:82/intf/forApp/follow.jsp
HTTP请求方式:

post

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id
pageNo string 当前第几页
pageSize string 每页显示的数量

返回参数

  {
   msg:    //提示信息
   result:  //1:取消关注成功;  0:该关注不存在或已取消关注
   pointCount:“点赞数”,
  }

10.他人主页 (新接口)))

开发人员:

mrobot,论坛(黄平),个人中心

HTTP请求方式:

get

是否需要登录:

返回格式:

JSON

缓存方式:

缓存时间:

请求参数:

参数名类型必须说明
uid string 登录用户id

返回参数

  {
  userId: 25237254, //用户ID
  isPoint:(0:未点赞,1已点赞)
  userName: "馨悦妈妈", //用户昵称
  pointCount:“点赞数”,
  level: “小宝宝”  // 用户等级
  userFaceUrl: "http://i1.3conline.com/images/upload/upc/face/25/23/72/54/25237254_50x50", //用户头像
  topics: [
    {
      topicId: 2155710, //帖子ID
      title: "终于收到宝贝与我!", //标题
      createAt: "2015-01-11 15:17:20", //发帖时间
      images:"http://img.pcbaby.com.cn/images/upload/upc/tx/kidsbbs6/1501/11/c0/1744371_1420960548132_1024x1024.jpg",//图片数组
    }
  ],
  total: 639 //总条数
  }

11 .帖子终端页,头像添加跳转协议:pcbabybrowser://personalCenter/(补充内容)

开发人员:

论坛(黄平)

案例接口:

 http://mrobot.pcbaby.com.cn/v2/bbs/topics/3359218?pageNo=1&size=17&picRule=2&v=270&newQuote=true&reverse=0&desc=true&inreview=1

12.我的金币接口:wap页面(新接口)

说明:

该页面需展示用户的当前金币数量,礼品兑换商城banner,金币活动

开发人员:

mrobot,论坛(黄平),郑少凡

拼接参数:

common_session_id = “”;

13,金币规则接口:wap页面(新接口)

说明:

需展示该用户各种规则的剩余机会次数

开发人员:

mrobot,论坛(黄平),郑少凡

拼接参数:

common_session_id = “”;

14,金币记录接口:wap页面(补充新接口))

说明:

一次加载20条记录(分页加载)

开发人员:

mrobot,论坛(黄平),郑少凡

拼接参数:

common_session_id = “”;

15.上传头像trac地址:(旧接口))

 http://rdtrac.pc.com.cn/upc/wiki/upc%20API使用#头像上传接口

16.修改个人信息trac地址:(旧接口))

 http://trac.pc.com.cn/baby_usercenter/ticket/37

17,图片验证码地址:(旧接口) )

 http://captcha.pclady.com.cn/captcha/v.jpg

18.接口调整:(旧接口)) )

这个接口获取全网最新200条数据

 http://mrobot.pcbaby.com.cn/s/qzbd/bbs/getNewTopics.xsp

19.获取登录用户信息接口

说明:

新增手机号(phone)、qq号(qq)2个字段

接口url: http://mrobot.pcbaby.com.cn/v2/bbs/getUserInfo