| Version 25 (modified by caomenglin, 11 years ago) (diff) |
|---|
Table of Contents
医美2.1.0接口文档
mrobot代理环境说明:
192.168.10.198:1080(192.168.74.80)
192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)
ps:未到qa阶段,连开发环境调试(若仅做代理,mrobot不存在真正的处理文件,只作转发的功能)
制作地址: http://zzsvn.pconline.com.cn/svn/zt/mobile/gz/lizijie/2015/0313-%ca%b1%c9%d0%cd%f8%d2%bd%c3%c0app/2.0%d3%a3%cc%d2%b0%ef/
bip接口地址: http://trac.pc.com.cn/bip/wiki/sysnotice
终端协议
1.首页
1.1首页数据接口(修改)
开发环境: http://dev15.pclady.com.cn/app/index.jsp
线上环境: http://plastic.pclady.com.cn/app/index.jsp
mrobot地址: http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/index.jsp
说明
修改部分:新增首页入口节点(indexEnter),删除特色展示节点(show),修改活动专场节点(activities)
缓存时间
15分钟
提交方式
GET
数据来源
焦点图:CMS、特色展示:CMS、活动专场:CMS、猜你喜欢:整形库编辑后台、推荐案例:整形库编辑后台,日记/帖子
修改内容
1:如果版本号小于210,indexEnter节点返回固定的JSON,如下
{
"status": 0,
"msg": "请求成功",
"data": [
{
"imageUrl": "http://img0.pclady.com.cn/pclady/plastic/ym2015/nq/1508/01.png",
"title": "精选机构",
"type": 1
},
{
"imageUrl": "http://img0.pclady.com.cn/pclady/plastic/ym2015/nq/1508/02.png",
"title": "人气项目",
"type": 2
},
{
"imageUrl": "http://img0.pclady.com.cn/pclady/plastic/ym2015/nq/1508/03.png",
"title": "今日秒杀",
"type": 3
},
{
"imageUrl": "http://img0.pclady.com.cn/pclady/plastic/ym2015/nq/1508/04.png",
"title": "领积分",
"type": 4
}
]
}
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| city | 城市 | String | "" | 否 |
| project | 感兴趣的项目 | String | "" | 否 |
| age | 年龄段 | int | "" | 否 |
| appVersion | 版本号 | String | "app版本号为x.x.x是,参数 传xxx,去掉小数点" | 否 |
返回
{
"listFocus": {
"status": 0,
"msg": "请求成功",
"data": [
{
"type": 1,
"imageUrl": " http://img.pconline.com.cn/7.jpg",
"url": "",
"contentID": "14324",
"circleContentID": "423"
}
]
},
"indexEnter": {
"status": 0,
"msg": "请求成功",
"data": [
{
"imageUrl": " http://img.pconline.com.cn/7.jpg",
"title": "功能1"
},
{
"imageUrl": " http://img.pconline.com.cn/7.jpg",
"title": "功能2"
}
]
},
"activities": {
"status": 0,
"msg": "请求成功",
"data": [
{
"type": 1,
"imageUrl": "http: //img.pconline.com.cn/7.jpg",
"url": "",
"contentID": "14324",
"circleContentID": "123"
}
]
},
"guessYouLike": {
"status": 0,
"msg": "请求成功",
"data": [
{
"likeID": "24234",
"title": "标题",
"typeName": "限量30份",
"imageUrl": "http: //img.pconline.com.cn/7.jpg",
"price": 999,
"discountPrice": 1,
"businessName": "深圳广济医疗美容医院",
"doctor": "陈柯",
"beginTime": "2015-05-01",
"buyTotal": 100,
"isEnd": 1
}
]
}
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| listFocus | 焦点图 | indexEnter | 首页入口 |
| activities | 活动专场 | guessYouLike | 猜你喜欢,字段说明参考活动列表 |
1.2帖子精选
开发环境: http://dev15.pclady.com.cn/app/essencePostList.jsp
线上环境: http://plastic.pclady.com.cn/app/essencePostList.jsp
mrobot地址: http://mrobot.pclady.com.cn/s-900/yimei/cms/essencePostList.xsp
说明
获取帖子精选
缓存时间
15分钟
提交方式
GET
是否登录
否
数据来源
整形库编辑后台
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 |
返回
{
"status": 0,
"msg": "请求成功",
"pageNo": 1,
"pageSize": 20,
"total": 100,
"data": [
{
"cornerType": "角标",
"imageUrl": "",
"title": "",
"message": "",
"contentID": 111
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| contentID | 内容ID | title | 标题 |
| cornerType | 角标 | imageUrl | 图片地址 |
| type | 1:日记,2:帖子 | imageUrl | 推荐图 |
| message | 帮主说两句 |
1.3.获取项目列表(修改)
开发环境: http://dev15.pclady.com.cn/app/getProjectList.jsp
线上环境: http://plastic.pclady.com.cn/app/getProjectList.jsp
mrobot环境: http://mrobot.pclady.com.cn/x-86400/yimei-plastic/app/getProjectList.jsp
说明
获取部位,项目
缓存时间
24小时
提交方式
GET
数据来源
整形库编辑后台
修改内容
1:请求参数添加appVersion,版本号大于等2.1.0时才返回热点项目
2:返回参数中一级项目添加subTitle、imageUrl,type
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| appVersion | 版本号 | int | "" | 否 | 版本号去掉.如2.1.0->210 |
返回
{
"status": 0,
"msg": "请求成功",
"total": 11,
"data": [
{
"typeID": "1",
"name": "一级部位",
"subTitle": "我是小标题",
"imageUrl": "",
"type":1,
"item": [
{
"typeID": "101",
"name": "二级部位",
"item": [
{
"typeID": "201",
"name": "项目名称"
}
]
}
]
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| typeID | 类型ID | name | 部位名称 |
| subTitle | 热点项目的二级标题 | imageUrl | 热点项目的图片地址 |
| type | 1:热点项目,0:其它项目 |
1.4获取案例列表(修改)
开发环境: http://dev15.pclady.com.cn/app/getExampleList.jsp
线上环境: http://plastic.pclady.com.cn/app/getExampleList.jsp
mrobot环境: http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/getExampleList.jsp
说明
获取案例列表
缓存时间
15分钟
提交方式
GET
数据来源
整形库编辑后台
修改内容
1:请求参数添加appVersion,版本号大于等2.1.0需要返回日记和案例
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 3 | 是 | |
| age | 年龄段 | int | "" | 否 | |
| positionID | 部位ID | String | "" | 否 | 部位,一级分类ID、感兴趣ID |
| subPositionID | 部位ID | String | "" | 否 | 功效,二级分类ID |
| projectID | 项目ID | String | "" | 否 | 三级分类ID |
| doctorID | 医生ID | String | "" | 否 | 医生主页中会根据医生来获取案例 |
| businessID | 医院ID | String | "" | 否 | 医院主页中会根据医院来获取案例 |
| city | 城市 | String | "" | 否 | 首页查询时用到 |
| activityID | 活动ID | String | "" | 否 | 活动详情页用到 |
| appVersion | 版本号 | String | "" | 否 | 版本号大于等于2.1.0时,需要返回日记和案例 |
返回
{
"status": 0,
"msg": "请求成功",
"pageNo": 1,
"pageSize": 20,
"total": 100,
" data": [
{
"contentID": "",
"type": 1,
"title": "",
"desc": "",
"imageUrl": [
"",
"",
""
],
" username": "小美",
"time": "2015-01-24",
"userType":1,
" essence": 1,
"publicationPhoto": 1
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| contentID | 案例ID或日记ID | type | 类型:1:日记,2:案例 |
| title | 标题 | desc | 描述 |
| imageUrl | 图片 | username | 昵称 |
| essence | 是否精华:1:是,0:否 | publicationPhoto | 是否晒单:1:是,0:否 |
| time | 发布时间 | userType | 1:达人,2:医生 |
2.搜索
2.1热点查询
开发环境: http://dev15.pclady.com.cn/app/hotList.jsp
线上环境: http://plastic.pclady.com.cn/app/hotList.jsp
mrobot地址: http://mrobot.pclady.com.cn/s-900/yimei/cms/hotList.xsp
说明
获取搜索中的热点名称
缓存时间
15分钟
提交方式
GET
是否登录
否
数据来源
整形库编辑后台
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|
返回
{
"status": 0,
"msg": "请求成功",
"hot": [
{
"type": 1,
"name": ""
},
{
"type": 2,
"name": ""
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| type | 热度分为1-4,热度大小对应不同大小的圆,数量如下:热度1:1个 热度2:2个 热度3:3个 热度4:3个 | name | 名称 |
2.2搜索
开发环境: http://dev15.pclady.com.cn/app/search.jsp
线上环境: http://plastic.pclady.com.cn/app/search.jsp
mrobot地址: http://mrobot.pclady.com.cn/s-900/yimei/cms/search.xsp
说明
搜索优惠、日记、帖子、医院、医生、项目
缓存时间
15分钟
提交方式
GET
是否登录
否
数据来源
整形库编辑后台
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| name | 页面大小 | String | "" | 是 | |
| type | 类型 | String | "" | 是 | 1:优惠、2:日记、3:帖子、4:医院、5:医生、6:项目 |
当type为空时,优惠活动、日记/帖子、医院返回三条,医生和项目返回4条,pageNo和pageSize不需要传,不需要返回pageNo、pageSize、total
当type不为空时,需要传pageNo和pageSize,需要返回pageNo、pageSize、total,没数据的节点不需要返回
返回
{
"status": 0,
"msg": "请求成功",
"pageNo": 1,
"pageSize": 20,
"activity": [],
"circle": [],
"total":100,
"hospital": [
{
"hospitalID": 1,
"name": "医院名称",
"imageUrl": "",
"type": 1,
"department": "美容科"
}
],
"doctor": [],
"project": [
{
"projectID": 201,
"name": "项目名称"
}
]
}
返回参数说明
活动: http://rdtrac.pc.com.cn/iphone/wiki/yimei1.0.0_api#a4.1获取优惠活动列表
圈子: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a2.2获取圈子内容列表
医生: http://rdtrac.pc.com.cn/iphone/wiki/yimei1.0.0_api#a7.1获取医生列表
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| activity | 活动节点 | circle | 圈子节点,包括日记和帖子 |
| hospital | 医院节点 | doctor | 医生节点 |
| project | 项目节点 | hospitalID | 医院ID |
| imageUrl | 图片地址 | department | 医院科室 |
| type | 1:普通商户、2:认证商户、3:VIP商户 | projectID | 项目ID |
3.专场
3.1获取专场详情(修改)
(接口已完成,使用请连开发机代理)
开发环境: http://dev15.pclady.com.cn/app/getSpecial.jsp
线上环境: http://plastic.pclady.com.cn/app/getSpecial.jsp
mrobot地址: http://mrobot.pclady.com.cn/x-900/yimei-plastic/app/getSpecial.jsp
说明
获取专场列表
缓存时间
15分钟
提交方式
GET
数据来源
整形库编辑后台
修改内容
1:返回参数添加guide节点
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 |
|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 |
| pageSize | 页面大小 | int | 4 | 是 |
| specialID | 专场ID | String | ”” | 是 |
返回
{
"status": 0,
"msg": "请求成功",
"pageNo": 1,
"pageSize": 20,
"total": 100,
"guide": {
"guideMessage": "",
"guideImageUrl": ""
},
"special": {
"title": "陈柯",
"city": "广州,深圳,北京",
"discount": "",
"buyTotal": 12,
" imageUrl": ""
},
"data": [
{
"activitiesID": "",
"title": "",
"typeName": "",
"imageUr": "",
"price": 999,
"discountPrice": 1,
"businessName": "深圳广济医疗美容医院",
"doctor": "陈柯",
"beginTime": "",
"buyTotal": 100,
"isEnd": 1
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| guideMessage | 专场导语 | guideImageUrl | 专场介绍图 |
4.达人标识
4.1添加达人标识(修改)
圈子相关接口返回时添加达人标识(userType,userTypeImage),需要修改的接口如下
精选推荐: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a1.1精选推荐
获取圈子内容列表: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a2.2获取圈子内容列表
日记详情页: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a2.4日记详情页WEB页
帖子详情页: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a2.5帖子详情页WEB页
评论列表: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a2.10评论列表
用户主页: http://rdtrac.pc.com.cn/iphone/wiki/yimei2.0.0_api#a3.1用户主页
获取用户资料: http://rdtrac.pc.com.cn/iphone/wiki/yimei1.0.0_api#a11.1获取用户资料
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| userType | 1:达人,2:医生 | userTypeImage | 达人图标 |
5.日记
5.1发日记(修改)
开发环境: http://dev15.pclady.com.cn/app/addDiary.jsp
线上环境: http://plastic.pclady.com.cn/app/addDiary.jsp
说明
发日记
缓存时间
0分钟
提交方式
POST
是否登录
是
数据来源
整形库编辑后台
修改内容
1:请求参数添加surgeryDate、nodeDate、appVersion字段
2:当版本号大于210 时,image参数不需要传,content中包括图片和文字,图片用img标签组装
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| diaryID | 日记ID | string | "" | 是 | 没传ID表示新日记,有ID表示续写 |
| projectID | 项目ID | string | "" | 是 | "三级ID1,三级ID2,三级ID3",类别ID用英文逗号隔开 |
| title | 标题 | string | "" | 是 | |
| content | 内容 | string | "" | 是 | |
| image | 图片 | string | "" | 是 | 用;myAppImg;隔开,最多9张 |
| orgID | 机构ID | string | "" | 否 | 模糊搜索选择的机构需要传ID ,不用传名称 |
| orgName | 手动输入的机构名 | string | "" | 否 | 新增机构需要传名称,不需要ID |
| orgCity | 机构所在城市 | string | "" | 否 | |
| orgDoctorID | 机构中的医生 | string | "" | 否 | 模糊搜索选择的医生需要传ID ,不用传名称 |
| orgDoctorName | 手动输入的医生 | string | "" | 否 | 新增医生需要传名称,不需要ID |
| price | 价格 | string | "" | 否 | |
| orderID | 订单ID | string | "" | 否 | 晒单要传订单ID,传入订单号时,机构等信息和项目信息不需要传 |
| surgeryDate | 手术时间 | string | "" | 是 | 手术时间 |
| nodeDate | 当前节点时间 | string | "" | 是 | 当前节点时间 |
| appVersion | 版本号 | string | "" | 是 | 版本号去掉.如2.1.0->210 |
返回
{
"status":0,
"msg":"请求成功",
"Integral":20,
"contentID",111111
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| Integral | 奖励积分 | contentID | 日记ID,新增的时候返回,续写不需要返回 |
5.2日记详情页(修改)
(mrobot已完成,请连开发机进行测试)
开发环境: http://dev15.pclady.com.cn/app/diaryInfo.jsp?diaryID=111&pageNo=1&pageSize=10&deviceID=91
http://dev15.pclady.com.cn/app/commentList.jsp?contentID=111&contentType=1&pageNo=1&pageSize=3
线上环境: http://plastic.pclady.com.cn/app/diaryInfo.jsp
mrobot地址: http://mrobot.pclady.com.cn/s/yimei/circle/diary.xsp
说明
日记终端页,应用端只需要出数据,wap页由mrobot来完成。
缓存时间
0分钟
提交方式
GET
是否登录
查询收藏状态时需要登录,其它情况不需要登录
数据来源
整形库编辑后台
修改内容
1:请求参数添加order、nodeDate、appVersion字段
2:返回参数添加userType、surgeryDate、afterDay
3:返回参数删除imageList节点
4:返回参数添加diaryNode节点
5:当appVersion大于等于210时,diaryContent返回图片混排
参数
| 参数名 | 参数含义 | 类型 | 默认值 | 是否必须 | 说明 |
|---|---|---|---|---|---|
| pageNo | 页数 | int | 1 | 是 | |
| pageSize | 页面大小 | int | 10 | 是 | |
| diaryID | 日记ID | string | "" | 是 | |
| deviceID | 设备ID | string | "" | 是 | |
| fmt | fmt=json 时显示接口数据 | String | "" | 否 | |
| order | 1:正序,2:倒序 | "" | 否 |
返回
{
"status": 0,
"msg": "请求成功",
"pageNo": 1,
"pageSize": 20,
"total": 100,
"diaryID": "",
"hasCollect": "",
"diaryTitle": "",
"hasLaud": "",
"projectList": [
{
"projectID": 11,
"projectName": ""
},
{
"projectID": 11,
"projectName": ""
}
],
"isessence": 1,
"ispublicationPhoto": 1,
"org": {
"hospital": "",
"doctor": "",
"hospitalCity": "",
"price": 1200,
"orgID": 111,
"doctorID": 11111
},
"nickName": "",
"userAge": 30,
"userCity": "",
"userID": "",
"userType": 1,
"userTypeImage":"http://7.png",
"surgeryDate": "",
"afterDay": 1,
"commentCount": 1,
"laudCount": 2,
"activityName": "",
"activityID": "",
"sysTime": "系统当前时间YYYY-MM-DD HH:mm:ss",
"data": [
{
"diaryDependId": 111,
"createTime": "",
"diaryContent": "日记内容",
"largeImageList": [
"image1",
"image2",
"image3"
]
}
],
"diaryNode": [
{
"title": "术后一天",
"date": "2015-10-10"
}
]
}
html中的json,mrobot组装
{
"circleName": "",
"commentCount": 1,
"laudCount": 2,
"hasCollect": "",
"hasLaud": 1,
"userID": "",
"userType":1,
"title": "",
"data": [
{
"largeImageList": [
"image1",
"image2",
"image3"
]
}
],
"diaryNode": [
{
"title": "术后一天",
"date": "2015-10-10"
}
]
}
返回参数说明
| 参数名 | 参数含义 | 参数名 | 参数含意 |
|---|---|---|---|
| hasCollect | 1:收藏,2:未收藏 | diaryTitle | 日记标题 |
| projectID | 项目ID | projectName | 项目名 |
| isessence | 是否精华:1:是,0:否 | ispublicationPhoto | 是否晒单:1:是,0:否 |
| hospital | 医院名 | doctor | 医生 |
| hospitalCity | 医院所在城市 | price | 价格 |
| nickName | 用户昵称 | userAge | 用户年龄 |
| userCity | 用户所在城市 | userID | 用户头像 |
| commentCount | 评论数 | laudCount | 点赞数 |
| userID | 用户ID为自己时,界面下文显示续写日记 | createTime | 发由时间 |
| imageList | 列表显示小尺寸图片 | largeImageList | 查看时需要请求大尺寸图片 |
| hasLaud | 是否点赞,1:已点赞,0:未点赞 | activityName | 活动名 |
| org | 机构信息,没有机构信息时,不需要返回该节点 | diaryDependId | 日记节点 |
| surgeryDate | 手术日期 | afterDay | 日记写到术后多少天 |
| diaryNode-> title | 节点标题,术后XX天 | diaryNode->date | 节点日期 |
![(please configure the [header_logo] section in trac.ini)](http://www1.pconline.com.cn/hr/2009/global/images/logo.gif)