wiki:pcauto_drive_2.1.0/interface

Version 3 (modified by liguokai, 11 years ago) (diff)

--

学车2.1.0接口文档

mrobot代理环境说明:

192.168.10.198 端口为 1080 连的是QA测试环境(192.168.74.80)
192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)
ps:对于mrobot.pcauto.com.cn/x/前缀的接口,mrobot仅作代理,没有任何逻辑处理。
制作地址:
应用后端接口trac:

1.考试内容


1.1考试文章终端页(web页)

(开发进行中)
开发环境:
线上环境: http://192.168.10.74:8003/interface/pcauto/mrobot_articles_v3.jsp?id=6849687
mrobot地址:

说明

获取cms录入的考试文章

缓存时间

分钟

提交方式

GET

是否登录

数据来源

cms

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1 为1时返回主页的内容
pageSize页面大小int20
articleId 文章ID string "" 应用端需要

返回

返回HTML页面

返回参数说明

参数名 参数含义 参数名参数含意

2.考场


2.1考场城市列表

(开发进行中)
开发环境:
线上环境:
mrobot地址:

说明

获取已知考场的城市列表

缓存时间

小时

提交方式

GET

是否登录

数据来源

学车后台

参数

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

返回


返回参数说明

参数名 参数含义 参数名参数含意

2.2考场列表

(开发进行中)
开发环境:
线上环境:
mrobot地址:

说明

获取某个城市下的考场列表

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

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

返回

返回参数说明

参数名 参数含义 参数名参数含意

2.3考场详情页(web页)

(开发进行中)
开发环境:
线上环境:
mrobot地址:

说明

获取学车后台录入的考场详情。

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

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

返回

返回HTML页面

返回参数说明

参数名 参数含义 参数名参数含意

3.基础知识


3.1基础知识主页

(开发进行中)
开发环境:
线上环境:
mrobot地址:

说明

获取基础知识主页

缓存时间

分钟

提交方式

GET

是否登录

数据来源

cms

参数

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

返回

返回参数说明

参数名 参数含义 参数名参数含意

4.五大项目


4.1五大图集

(mrobot已完成,请连开发机进行测试)
开发环境: http://dev31.pconline.com.cn:8042/intf/group_photo.jsp?groupId=2506
线上环境: http://plastic.pclady.com.cn/app/organizationList.jsp
mrobot地址:  http://mrobot.pcauto.com.cn/x/dev31.pconline.com.cn:8042/intf/group_photo.jsp?groupId=2506

说明

获取图集内容

缓存时间

提交方式

GET

是否登录

数据来源

图库后台

参数

参数名 参数含义 类型 默认值 是否必须
groupId图集idstring""

返回

{
    "cover": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s_medium.jpg",
    "desc": "最牛停车场! 汽车坠楼全过程 \r\n更多图片请点击进入:http://bbs.pcauto.com.cn/topic.jsp?tid=1168108\r\n来源:PCauto网友    为人民服务",
    "groupId": 2506,
    "name": "最牛停车场! 汽车坠楼全过程 ",
    "number": 1,
    "photos": [
        {
            "desc": "",
            "name": "",
            "photoId": 62051,
            "sourceUrl": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s.jpg",
            "thumbUrl": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s_small.jpg"
        }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意参数名参数含意参数名参数含意参数名参数含意参数名参数含意参数名参数含意参数名参数含意
cover 封面图 desc描述 groupId图集id name标题 number图片数量 photoId图片id sourceUrl图片链接 thumbUrl缩略图链接

4.2获取晒单中的机构信息

(mrobot已完成,请连开发机进行测试)
开发环境: http://dev15.pclady.com.cn/app/getOrgInfo.jsp?activitiesID=1
线上环境: http://plastic.pclady.com.cn/app/getOrgInfo.jsp
mrobot地址:  http://mrobot.pclady.com.cn/s-3600/yimei/org/getOrgInfo.xsp

说明

从订单列表中进入晒单时,可以查看该活动的机构信息,但机构信息不能编辑,只能看

缓存时间

60分钟

提交方式

GET

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
activitiesID活动IDstring""

返回

{
  "status":0,
  "msg":"请求成功",
  "data":[{ 
    "orgName":"",
    "doctorName":"",
    "price":1000,
    "city":""
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
orgName 机构名称 doctorName 医生姓名
price 价格 city 城市

2.6完善机构信息

开发环境: http://dev15.pclady.com.cn/app/perfectOrg.jsp
线上环境: http://plastic.pclady.com.cn/app/perfectOrg.jsp

说明

完善机构信息

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
diaryID 日记ID string ""
orgID 机构ID string "" 如果有机构需要传ID ,不用传名称
orgName 手动输入的机构名 string "" 新增机构需要传名称,不需要ID
orgCity 机构所在城市 string ""
orgDoctorID 机构中的医生 string "" 模糊搜索选择的医生需要传ID ,不用传名称
orgDoctorName 手动输入的医生 string "" 新增医生需要传名称,不需要ID
price 价格 string ""

返回

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

返回参数说明

参数名 参数含义 参数名参数含意
Integral 奖励积分 参数名参数含意

5:旧接口修改

5.1获取收藏列表 ===(V1.1.0中的接口修改)

开发环境: http://dev15.pclady.com.cn/app/getCollectList.jsp
线上环境: http://plastic.pclady.com.cn/app/getCollectList.jsp
mrobot环境接口

 http://mrobot.pclady.com.cn/s/yimei/my/getCollectList.xsp?type=2&pageSize=2&pageNo=2

说明

根据类型获取收藏列表

缓存时间

0

提交方式

GET

是否需要登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1
pageSize页面大小int3
type类型:1:活动,2,案例,3:圈子 int 1(默认是1,只取其中之一)
deviceID 设备ID string ""

返回

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  "sysTime":"系统当前时间YYYY-MM-DD HH:mm:ss,类型为圈子时才返回
"
  data:{
    activitiesList:[{ 
      activitiesID:””, 
      title:””, 
      typeName:””, 
      imageUrl””, 
      price:999, 
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100, 
      state:1,
      hasDelete:1
    }],
//////////////////////////////////////////////////////按类型的不同,取不同的结果
  exampleList:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””,
      hasDelete:1
    }],
//////////////////////////////////////////////////////按类型的不同,取不同的结果,类型为3,4时取circle
  "circle":[{ 
    "contentID":"",
    "nickName":"", 
    "userID":"", 
    "type":”1:日记,2:帖子”, 
    "imageUrl":"", 
    "title":"", 
    "commentCount":1,
    "laudCount":1,
    "dateTime":"刚刚",
    "hasDelete":1,
    "hasLaud":1,
    "isExample":1,
    "isessence":1,
    "ispublicationPhoto":1,
    }
  ]

  }
}

返回参数说明

参数名 参数含义 参数名参数含意
hasDelete 是否删除,1:已删除,2:未删除(删除一个月后的数据,自动取消收藏关系) age 年龄段
hasLaud是否点赞,1:已点赞,0:未点赞isExample类型为圈子时,isExample==1表示旧案例数据
isessence是否精华:1:是,0:否 ispublicationPhoto是否晒单:1:是,0:否

5.2收藏/取消收藏 ===(V1.1.0中的接口修改)

开发环境: http://dev15.pclady.com.cn/app/collectForApp.jsp
线上环境: http://plastic.pclady.com.cn/app/collectForApp.jsp

collectForApp

说明

用于添加收藏和取消收藏

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
typeID类型ID,分别为活动ID、案例ID,批量取消收藏时,用英文逗号隔开 String ""
type类型:1:活动,2,案例,3:圈子,日记和帖子都传3 int ""
operation操作:1:收藏,2:取消收藏 int ""

返回

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

5.3分享好友

开发环境: http://dev15.pclady.com.cn/app/shareFriend.jsp
线上环境: http://plastic.pclady.com.cn/app/shareFriend.jsp

说明

分享好友,加积分,分享案例、晒单、日记加20分,分享好友加10分

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
r时间截String""
signMD5加密串String""
type类型String""type=1表示分享晒单,日记等。

返回

5.4功能入口(CMS新增)

CMS地址:

 http://plastic.pclady.com.cn/ym2015/nq/1508/intf8728.js 首页入口

说明

首页入口

缓存时间

15分钟

提交方式

GET

数据来源

CMS

参数

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

返回

{
    "status": 0,
    "msg": "请求成功",
    "data": [
        {
            "imageUrl": " http://img.pconline.com.cn/7.jpg",
            "title": "找机构",
            "type": 1
        },
        {
            "imageUrl": " http://img.pconline.com.cn/8.jpg",
            "title": "找项目",
            "type": 2
        },
        {
            "imageUrl": " http://img.pconline.com.cn/9.jpg",
            "title": "写日记",
            "type": 3
        },
        {
            "imageUrl": " http://img.pconline.com.cn/10.jpg",
            "title": "领积分",
            "type": 4
        }
    ]
}

5.5活动专场(CMS,新增)

CMS地址:  http://plastic.pclady.com.cn/ym2015/nq/1508/intf8727.js 活动专场

说明

获取活动专场,3条

缓存时间

15分钟

提交方式

GET

数据来源

CMS

参数

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

返回

{
    "status": 0,
    "msg": "请求成功",
    "data": [
        {
            "type": 1,
            "imageUrl": "http: //img.pconline.com.cn/7.jpg",
            "url": "",
            "contentID": "14324",
            "circleContentID": "123"
        },{
            "type": 1,
            "imageUrl": "http: //img.pconline.com.cn/7.jpg",
            "url": "",
            "contentID": "14324",
            "circleContentID": "123"
        },{
            "type": 5,
            "imageUrl": "http: //img.pconline.com.cn/7.jpg",
            "url": "",
            "contentID": "14324",
            "circleContentID": "123",
            "circleContentType":"1"
        }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
type 1:活动详情页,2:专场详情页,3,案例详情页,4:项目详情页,5:外链URL(为了兼容旧版,日记/帖子也用此类型,URL为日记/帖子的wap地址),6:活动列表,7:专场列表,8:案例列表,9:我的积分,10:一元秒杀11:机构列表,12:医院详情页 contentID 文章类的ID
url 如果类型为5,需要URL,如果是日记/帖子,需要circleContentID和type,circleContentType类型,1:日记,2帖子 circleContentID 日记或帖子ID
circleContentType 如果类型为5,如果是日记/帖子,需要circleContentID和circleContentType,circleContentType类型,1:日记,2帖子

5.6首页数据接口(修改)

开发环境: 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、猜你喜欢:整形库编辑后台、推荐案例:整形库编辑后台,日记/帖子

参数

参数名 参数含义 类型 默认值 是否必须
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 猜你喜欢,字段说明参考活动列表

5.7机构列表 (新增)

开发环境: http://dev15.pclady.com.cn/app/indexOrgList.jsp
线上环境: http://plastic.pclady.com.cn/app/indexOrgList.jsp
mrobot地址:  http://http.pclady.com.cn/s-900/yimei/org/indexOrgList.xsp?pageNo=1&pageSize=10

说明

从首页入口进入的机构列表

缓存时间

15分钟

提交方式

GET

数据来源

整形库

参数

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

返回

{
    "status": 0,
    "msg": "请求成功",
  "pageNo": 1, 
  "pageSize": 10,
    "total":100,
    "data": [
        {
    "orgID": 1,
    "imageUrl": "http: //img.pconline.com.cn/7.jpg",
    "name": "",
    "address": "广州",
    "plScore": 10,
    "serviceScore": 5,
    "technologyScore": 3,
    "environmentScore": 5
},{
    "orgID": 1,
    "imageUrl": "http: //img.pconline.com.cn/7.jpg",
    "name": "",
    "address": "广州",
    "plScore": 10,
    "serviceScore": 5,
    "technologyScore": 3,
    "environmentScore": 5
},{
    "orgID": 1,
    "imageUrl": "http: //img.pconline.com.cn/7.jpg",
    "name": "",
    "address": "广州",
    "plScore": 10,
    "serviceScore": 5,
    "technologyScore": 3,
    "environmentScore": 5
}
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
orgID 机构ID imageUrl 图片
name 机构名 address 机构地址
plScore 星级 serviceScore 服务
technologyScore 技术 environmentScore 环境

6.其它


6.1启动上报

开发环境: http://dev15.pclady.com.cn/app/reportStartUp.jsp
线上环境: http://plastic.pclady.com.cn/app/reportStartUp.jsp

说明

当天用户第一次启动时,需要上报一次。便于判断活跃度

缓存时间

0

提交方式

POST

是否登录

数据来源

整形库编辑后台

参数

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

返回

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

返回参数说明

参数名 参数含义 参数名参数含意