wiki:yimei2.0.0_api

Version 9 (modified by caomenglin, 11 years ago) (diff)

--

医美2.0.0接口文档

mrobot代理环境说明:

192.168.10.198:1080(192.168.74.80)
192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)
ps:未到qa阶段,连开发环境调试(若仅做代理,mrobot不存在真正的处理文件,只作转发的功能)

1.首页


1.1精华推荐

开发环境: http://dev15.pclady.com.cn/app/essenceList.jsp
线上环境: http://plastic.pclady.com.cn/app/essenceList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/essenceList.jsp

说明

获取首页的精华推荐,由后台⼈工推荐内容,此列表累积显示历史数据,最新的数据显示在顶部;默认一次显⽰示10条数据,下 拉一次再加载10条

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[{ 
    "essenceID":"",
    "headUrl":"", 
    "nickName":"", 
    "userID":"", 
    "type":””, 
    "imageUrl":"", 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚"
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essenceID 精华ID headUrl 用户头像地址
nickName 用户昵称 userID 用户ID,用于查看ta的主页
type 1:日记,2:帖子 imageUrl 推荐图
commentCount 评论数 laudCount 点赞数
title 标题 dateTime 发表时间,取最新的时间

2.圈子


2.1获取圈子类型

开发环境: http://dev15.pclady.com.cn/app/communityTypeList.jsp
线上环境: http://plastic.pclady.com.cn/app/communityTypeList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/communityTypeList.jsp

说明

获取圈子类型

缓存时间

24小时

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明

返回

{
  "status":0,
  "msg":"请求成功",
  "total":11,
  "data":[{
    "typeID":"1",
    "name":"全部",
   },{
    "typeID":"2",
    "name":"眼部",
   }]
}

返回参数说明

参数名 参数含义 参数名参数含意
typeID 类型ID name 类型名

2.2获取圈子列表

开发环境: http://dev15.pclady.com.cn/app/communityList.jsp
线上环境: http://plastic.pclady.com.cn/app/communityList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/communityList.jsp

说明

获取圈子类型

缓存时间

24小时

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1
pageSize页面大小int10
typeID类型IDint10类型为全部的时候要返回精华推荐,最多三条
queryType查询类型int101:精华,2:最新,3:帖子,4:日记

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[{ 
    "essenceID":"",
    "headUrl":"", 
    "nickName":"", 
    "userID":"", 
    "type":””, 
    "imageUrl":"", 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚"
    }
  ],
  "top":[
{
    "essenceID":"",
    "typeName":"置顶",
    "title":"标题"},
{
    "essenceID":"",
    "title":"标题"
}
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essenceID 精华ID headUrl 用户头像地址
nickName 用户昵称 userID 用户ID,用于查看ta的主页
type 1:日记,2:帖子 imageUrl 推荐图
commentCount 评论数 laudCount 点赞数
title 标题 dateTime 发表时间,取最新的时间
top 置顶信息,最多三条

2.3圈子列表页最新消息

开发环境: http://dev15.pclady.com.cn/app/getNewMessage.jsp
线上环境: http://plastic.pclady.com.cn/app/getNewMessage.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/getNewMessage.jsp

说明

若用户收到回复/评论,系统信息,在圈子⾸页”精华“和”最新“两个界面下显示信息提示条;【日记/帖子加精、删除、编辑推送信息不在此处提示,⽤户之间的回 复/评论消息才在这⾥提醒】

缓存时间

0

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明

返回

{
  "status":0,
  "msg":"请求成功",
  "headUrl": "", 
  "total": 100,
}

返回参数说明

参数名 参数含义 参数名参数含意
total 消息条数 headUrl 用户头像地址

3.我的主页


3.1用户主页

开发环境: http://dev15.pclady.com.cn/app/getUserIndex.jsp
线上环境: http://plastic.pclady.com.cn/app/getUserIndext.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/getUserIndex.jsp

说明

获取用户主页

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10
userID用户IDint0

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "nickNmae",
  "headUrl":"", 
  "shareCount":158,
  "city":"北京",
  "data":[{ 
    "essenceID":"",
    "type":””, 
    "imageUrl":["image1","image2","image3"], 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚"
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essenceID 精华ID headUrl 用户头像地址
nickName 用户昵称 userID 用户ID,用于查看ta的主页
type 1:日记,2:帖子 imageUrl 推荐图
commentCount 评论数 laudCount 点赞数
title 标题 dateTime 发表时间,取最新的时间
shareCount 分享数量 city 城市,只需返回城市名

3.2兑换码换积分

开发环境: http://dev15.pclady.com.cn/app/convertibilityScore.jsp
线上环境: http://plastic.pclady.com.cn/app/convertibilityScore.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/convertibilityScore.jsp

说明

获取用户主页

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10
convertibilityNum兑换码int0
r时间截String""
signMD5加密串String""

返回

{
  "status":0,
  "msg":"请求成功",
}

3.3用户日记列表

开发环境: http://dev15.pclady.com.cn/app/myDiaryList.jsp
线上环境: http://plastic.pclady.com.cn/app/myDiaryList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/myDiaryList.jsp

说明

获取用户日记列表

缓存时间

0

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10
userID用户IDint0

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[{ 
    "essenceID":"",
    "imageUrl":"image1", 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚",
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essenceID 精华ID imageUrl 日记图片,取最新的一张
title 标题 dateTime 发表时间,取最新的时间
commentCount 评论数 laudCount 点赞数

3.4用户帖子列表

开发环境: http://dev15.pclady.com.cn/app/myPostList.jsp
线上环境: http://plastic.pclady.com.cn/app/myPostList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/myPostList.jsp

说明

获取用户帖子列表

缓存时间

0

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10
userID用户IDint0

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[{ 
    "essenceID":"",
    "imageUrl":["image1","image2","image3"], 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚",
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essenceID 精华ID imageUrl 日记图片,取最新的一张
title 标题 dateTime 发表时间,取最新的时间
commentCount 评论数 laudCount 点赞数

3.5用户消息列表

开发环境: http://dev15.pclady.com.cn/app/myMessageList.jsp
线上环境: http://plastic.pclady.com.cn/app/myMessageList.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/myMessageList.jsp

说明

获取用户消息列表

缓存时间

0

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int10
userID用户IDint0

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[{ 
    "messageID":"",
    "messageType":1,
    "headUrl":"", 
    "nickName":"", 
    "userID":"", 
    "userType":2
    "contentType":””, 
    "imageUrl":"", 
    "messageContent":"", 
    "messageTitle":"",
    "contentID":1234,
    "contentUrl":"",
    "dateTime":"刚刚",
    "commentType":1
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
messageID 消息ID headUrl 回复人或评论人的头像地址,系统消息可不传,APP写死
nickName 回复人或评论人的昵称,系统消息可不传,APP写死 userID 用户ID或系统ID,用于查看ta的主页
contentType 1:日记,2:帖子,3:活动(系统消息可能包括活动推广) imageUrl 推荐图,系统消息中可发送图片
messageContent 消息内容 dateTime 发表时间,取最新的时间
userType 用户类型,1:系统,2:用户 messageType 消息类型,1:系统消息,2:评论,3:回复
contentID 内容ID,分别为日记,帖子,活动 messageTitle 消息标题,分别为:日记标题,帖子标题,回复内容
contentUrl 没ID的内容,可能为外链