wiki:pcauto_drive_2.3.0/interface

学车2.3.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仅作代理,没有任何逻辑处理。
制作地址: http://zzb.pcauto.com.cn/tools/gongdan/plan.php?id=122
应用后端接口trac: http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.2

1.cms与论坛


1.1科目一首页焦点图

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/topArticle.xsp

cms线上环境: http://www.pcauto.com.cn/client/xcbd/1509/intf7851.js

 http://www.pcauto.com.cn/client/xcbd/1511/intf8071.js

说明

科目首页今日推荐接口

缓存时间

0

提交方式

GET

是否登录

数据来源

CMS

参数

参数名 参数含义 类型 默认值 是否必须 说明
subjectId 科目id int 科目id(科目一:22486,科目二:22505,科目三:22487,科目四:22515,拿本:22695)

返回

{
    "status": 0,
    "message": "操作成功",
    "datas": [
        {
            "title": "文章",
            "id": "6790726",
            "type": 1,
            "img": "http://img0.pcauto.com.cn/pcauto/1507/14/g_6728785_1436863917510_240x160.jpg",
            "url": "http://m.pcauto.com.cn/x/679/6790726.html"
        },
    ],
   bannerData: [
        {
            "title": "教练在线问答回顾",
            "url: "http://bbs.pcauto.com.cn/topic-8771174.html",
            "imagePath": "http://img0.pcauto.com.cn/pcauto/client/xcbd/recommend/1511/00.jpg",
            "type": "2",
            "id": "8771174"
         }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含义
status 接口返回状态码:0成功,非0异常 message 接口返回描述信息
id 文章id,帖子id type 跳转类型:1文章页,2话题详情页,3专题页面,4游戏页面,5每日抽奖,6专家在线
tag 只有第一位出,标签 title 标题

1.2帖子报名功能

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/topicDetail.xsp

应用后端url: http://bbs.pcauto.com.cn/xcappapi/1/topic/topicDetail.ajax?resp_enc=utf-8&tid= (获取帖子详情)

 http://xueche.pcauto.com.cn/appapi/1.0/topic/getPraiseCountByTopicId.do?topicId= (获取帖子赞数)
 http://bbs.pcauto.com.cn/xcappapi/1/topic/photos.do?ajax=true&tid= (获取主贴图片列表)
 http://xueche.pcauto.com.cn/appapi/1.0/topic/isPraiseByUserId.do?userId=&topicIds= (是否已点赞)
 http://passport3.pcauto.com.cn/passport3/client/api/recognize.jsp (获取用户登录状态)
 http://bbs.pcauto.com.cn/activity/viewWap.ajax?tid=&type=all (获取报名用户列表)

说明

缓存时间

0

提交方式

GET

是否登录

登录与未登录都可请求

数据来源

论坛&学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
topicId 帖子id string
Cookie 用户登录cookie string 登录用户cookie,放在请求头中

返回 HTML [BR]

页面内数据说明:在返回的页面里添加了注释数据/*@_HTML_META_START_(数据部分)_HTML_META_END_@*/ 数据内容为 
  {
    "title": "学车发帖测试V2",(标题)
    "url": "http://dev11.pcauto.com.cn/bbs7/topic-7809286.html",(分享URL)
    "firstPic": "http://dev2.pconline.com.cn:9191/upcfiles/bbs6/1506/24/c0/19020_1435117706182_1024x1024.jpg"(第一张图)
  }

页面协议
    pcdrive://reply/floorId  (floorId)楼层id   回复楼层协议
    pcdrive://praise/tid   (tid) 帖子id  点赞协议
    pcdrive://big-photo?data={\"total\":" + total + ",\"currentIndex\":" + currentIndex + ",\"photos\":[" +photos+ "]}  (total)图片总数  (currentIndex)当前图片位置 (photos) 所有图片URL   点击图片协议
    pcdrive://enroll  我要报名协议
    pcdrive://submitEnroll  提交报名协议

1.3 启动图接口

(开发已完成)
安卓版如下

mrobot地址:mrobot.pcauto.com.cn/configs/xueche_android_qdtdh

ios版如下

mrobot地址:mrobot.pcauto.com.cn/configs/xueche_ios_qdtdh

后端Url:无

说明

启动图动画配置

缓存时间

0

提交方式

GET

是否登录

数据来源

mrobot后台

参数

返回

{
    "rule": {
        "delay": 1,
        "interval": 15,
        "age": 3
    },
    "ad": {
        "img": "http://img0.pcauto.com.cn/pcauto/1508/07/6242801_new.jpg",
        "to-uri": "pcautodrive://bbs-topics/8650721",
        "vc-uri": "http://192.168.20.6?a=3d",
        "cc-uri": "http://192.168.20.6?a=4d",
        "type":"2",
        "id":"8650721",
        "title":"这是一只标题",
        "comment":"type取值---->1:文章页;2:话题详情页;3:专题页面;4:游戏页面;5:每日抽奖;6:专家在线。to-uri---->论坛:pcautodrive://bbs-topics/8650721;文章:pcautodrive://info-articles/8650721;其他:直接填URL"
    }
}

返回参数说明

参数名 参数含义 参数名 参数含义
delay 延迟显示 interval 间隔显示
age 显示时间 img 图片链接
to-uri 到达页,论坛:pcdrive://bbs-topics/8650721;文章:pcdrive://info-articles/8650721;其他:直接填URL vc-uri 曝光计数
cc-uri 点击计数 type 类型,1:文章页;2:话题详情页;3:专题页面;4:游戏页面;5:每日抽奖;6:专家在线。
id 帖子或文章id(其它类型没有) title 标题

1.4 新增跳转类型

(只需要编辑录入新增类型,接口无改动)

mrobot地址:

活动列表: http://trac.pc.com.cn/iphone/wiki/pcauto_drive_2.0.0/interface#a2.1.6获取活动列表
urlType添加专家在线页标记
今日推荐: http://trac.pc.com.cn/iphone/wiki/pcauto_drive_2.2.0/interface#a2.2科目首页今日推荐接口
type添加专家在线页标记
圈子首页: http://trac.pc.com.cn/iphone/wiki/pcauto_drive_1.2.0/interface#a2.1.3精彩推荐帖子列表
type添加专家在线页标记
消息列表: http://trac.pc.com.cn/iphone/wiki/pcauto_drive_2.3.0/interface#a2.10消息列表
type添加专家在线页标记


1.5 科目首页专家在线接口

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/randomQuestion.xsp

cms线上环境: http://www.pcauto.com.cn/client/xcbd/1511/intf8091.js
学车线上环境: http://xueche.pcauto.com.cn/appapi/1.0/active/lastActive.do
说明

科目首页专家在线接口

缓存时间

0

提交方式

GET

是否登录

数据来源

CMS

参数

参数名 参数含义 类型 默认值 是否必须 说明
subjectId 科目id int 科目id(科目一:22486,科目二:22505,科目三:22487,科目四:22515)

返回

{
    "status": 0,
    "message": "操作成功",
    "questionList": [
        {
            "id": 440100,
            "title": "离合器半联动怎么找?"
        },
        {
            "id": 434500,
            "title": "科目三怎么踩离合才是正确的?"
        }
    ],
    "questionSpecial": [
        {
             "id": 31,
             "title": "教练在线解答",
             "activeImg": "http://dev2.pconline.com.cn:9191/upcfiles/driver/1511/03/c0/31433_1446519084528.jpg"
         }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含义
status 接口返回状态码:0成功,非0异常 message 接口返回描述信息
id 帖子id title 问答标题
title 专家在线标题 activeImg 专家在线图片

2.学车后台


2.1 大小压缩中的交通标志列表页

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/listTrafficSign.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/traffic/listTrafficSign.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/traffic/listTrafficSign.do

说明

获取交通标志

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
typeId 类型 int
pageNo 页码 string
pageSize 每页条数 string

返回

{
        code:0成功,-1失败
        message:失败原因
        signCount:总个数
        pageNo:页码
        pageSize:一页个数
        pageCount:总页数
        tracficList:[{
            img:原图URL
            signName:标志名字
            signDesc:标志描述
        }]
}

返回参数说明

参数名 参数含义 参数名 参数含义
img 原图URL signName 标志名字
signDesc 标志描述

2.2 商品详情

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/getGiftDetailById.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003//appapi/1.0/gift/getGiftDetailById.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/traffic/getGiftDetailById.do

说明

获取商品详情

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
giftId 礼品ID long
accountId 用户ID long 登陆后必须

返回

{
        code:0成功,-1失败
        message:失败原因
        date:{
            name:商口名字
            gold:兑换所需学分
            curNum:剩余库存
            limitNum:兑换上限
            imagePath:礼品详情图片链接
            smallCoverImg:160X120的封面图
            description:商品详细说明
            exchangeStatus:后台判断,0:马上兑换,-5:库存不足,-6:已达兑换上限,-2:分数不足
        }
}

返回参数说明

参数名 参数含义 参数名 参数含义
name 商口名字 gold 兑换所需学分
curNum 剩余库存 limitNum 兑换上限
imagePath 礼品详情图片链接 smallCoverImg 160X120的封面图
description 商品详细说明 exchangeStatus 后台判断

2.3 兑换记录列表

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/listRecord.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003//appapi/1.0/gift/listRecord.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/traffic/listRecord.do

说明

兑换记录列表

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
accountId 用户ID long
pageNo 页码 int
pageSize 页数 int

返回

{
        code:0成功,-1失败
        message:失败原因
        pageNo:页码
        pageSize:一页个数
        pageCount:总页数
        recordList:[{
            giftId:商品ID
            conversionId:兑换的ID
            giftImg:商品160X120地址
            name:商品名字
            status:0未发货,1已发货,2待付款,-1驳回(失败)
            createAt:创建时间
        }]
}

返回参数说明

参数名 参数含义 参数名 参数含义
giftId 商品ID conversionId 兑换的ID
giftImg 商品160X120地址 name 商品名字
status 0未发货,1已发货,2待付款,-1驳回(失败) createAt 创建时间

2.4 兑换商品

1.通过 http://trac.pc.com.cn/iphone/wiki/pcauto_drive_2.3.0/interface#a2.2商品详情拿到数据显示;
2.通过 http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.3#a1.3.礼品兑换接口2.3提交数据


2.5 兑换成功

1.通过 http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.3#a1.3.礼品兑换接口2.3返回的id拼接跳转链接


2.6 兑换详情

1.学车后台提供前缀,app用id拼接详情页链接


2.7 用户摇一摇今日剩余次数

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/getLeftShakeCount.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/shake/getLeftShakeCount.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/shake/getLeftShakeCount.do

说明

获取用户摇一摇今天的剩余次数

缓存时间

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
accountId 用户ID long

返回

{
        code:0成功,-1失败,-2未登录
        message:失败原因
        shakeCount:今天还剩的摇一摇次数
}

返回参数说明

参数名 参数含义 参数名 参数含义
code 状态码 message 描述
shakeCount 今天还剩的摇一摇次数

2.8 摇一摇出题

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/shakeAShake.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/shake/shakeAShake.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/shake/shakeAShake.do

说明

摇一摇出题目,注意:总次数是2次,但根据不同的subjcetID出题

缓存时间

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
accountId 用户ID long
subjectId 科目ID long

返回

{
        code:0成功,-1失败,-2未登录
        message:失败原因
        shakeCount:今天还剩的摇一摇次数
        questionId:
}

返回参数说明

参数名 参数含义 参数名 参数含义
code 状态码 message 描述
shakeCount 今天还剩的摇一摇次数 questionId 题目id

2.9 摇一摇加分接口

1.后端接口猛戳 http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.3#a1.7.摇一摇加分接口2.3


2.10 消息列表

(开发已完成)

mrobot地址: http://dev40.pcauto.com.cn/xsp/s/auto/info/xueChe/expertMessage.xsp

bip开发环境:
bip线上环境: http://bip.pcauto.com.cn/intf/sysnotice.jsp?act=find&siteId=2&typeIds=2071

说明

获取消息列表

缓存时间

提交方式

GET

是否登录

数据来源

BIP

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int 1
pageSize 分页大小 int 20

返回

{
        "total":55,  总记录数
        "pageNo":1,  当前第几页
        "pageCount":3,  一共有多少页
        "pageSize":20,  每页多少条记录
        "resultList":  消息列表
        [
           {
             "id":249723334,  消息ID
             "type":{"name":"官方活动","id":0,"templateId":0,"siteId":0,"groupType":1},  消息类型信息
             "content":{"content":"活动内容","activeId":12},  消息内容
             "createTime":1434540046000,  消息创建时间
             "status":1,  消息状态 0未读  1已读
             "accountId":7072562,  接收者ID
             "typeId":69,  消息类型Id
             "siteId":2,  消息属于那个网站
             "groupSend":1,  是否群发消息
             "groupType":0,  消息分组ID
             "senderId":0  发送者ID
            }
         ]
    }  

返回参数说明

参数名 参数含义 参数名 参数含义
id 消息ID type 消息类型信息
content 消息内容 createTime 消息创建时间
status 消息状态 accountId 接收者ID
typeId 消息类型Id siteId 消息属于那个网站
groupSend 是否群发消息 groupType 消息分组ID
senderId 发送者ID activeId 专家问答id

2.11 专题列表

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/listActive.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/active/listActive.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/active/listActive.do

说明

获取专题列表

缓存时间

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int
pageSize 每页条数 int

返回

{
        code:0成功,-1失败
        message:失败原因
        pageNo:页码
        pageSize:一页个数
        pageCount:总页数
        activeList:[{
            id:专题ID
            periods:期数
            title:标题
            coach:教练
            schoolName:驾校名
            timestart:开始时间
            timeEnd:活动结束时间
            status:0:进行中 ,1:未开始  ,-1:已结束
        }]
}

返回参数说明

参数名 参数含义 参数名 参数含义
id 专题ID periods 期数
title 标题 coach 教练
schoolName 驾校名 timestart 开始时间
timeEnd 活动结束时间 status 0:进行中 ,1:未开始 ,-1:已结束

2.12 单个专题页 & 教练主页 HTML

1.根据原型,该部分使用wap版。


2.13 获取省市

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/jsonProvinceAndCity.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/area/jsonProvinceAndCity.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/area/jsonProvinceAndCity.do

说明

获取最新专题

缓存时间

提交方式

GET

是否登录

数据来源

学车后台

参数

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

返回

{
        code:0成功,-1失败
        message:失败原因
        addressList:[{
            provincepy:省的首字母拼音
            provinceId:省ID
            province:省名
            cityId:城市ID
            city:城市名
        }]
}

返回参数说明

参数名 参数含义 参数名 参数含义
provincepy 省的首字母拼音 provinceId 省ID
province 省名 cityId 城市ID
city 城市名

2.14 交通标志类型列表页接口

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/listTrafficType.xsp

学车后台开发环境: http://dev38.pcauto.com.cn:8003/appapi/1.0/traffic/listTrafficType.do
学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/traffic/listTrafficType.do

说明

交通标志类型列表页

缓存时间

0

提交方式

GET

是否登录

数据来源

学车后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
typeId 类型 int 父类(type=0时,查询一级分类,type>0时,是查询该类型的下一级分类)
pageNo 页码 string
pageSize 每页条数 string

返回

{
        code:0成功,-1失败
        message:失败原因
        pageNo:页码
        pageSize:一页个数
        pageCount:总页数
        tracficTypeList:[{
            id:类型的ID
            name:标志名字
            description:标志描述
            hasChild:是否含有子结点
            totalImg:总图片数
        }]
}

返回参数说明

参数名 参数含义 参数名 参数含义
id 类型的ID name 标志名字
description 标志描述 hasChild 是否含有子结点
totalImg 总图片数

3.活动

3.1 获取实物奖品记录

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/activityPrizeList.xsp

活动后台开发环境: http://v39.pcauto.com.cn:8003/action/getRecord.jsp
活动后台线上环境: http://activity.pcauto.com.cn/auto151019/action/getRecord.jsp

说明

获取实物奖品记录

缓存时间

提交方式

GET

是否登录

数据来源

活动后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageSize 每页显示数 int 5
pageNo 页码 int 1

返回

{"code":-1,"msg":"活动已结束,感谢您的参与"}
{"code":-2,"msg":"请登陆后查看中奖记录"}
{"code":-3,"msg":"获取中奖记录失败"}
{"code":1,"msg":"获取中奖记录成功","count":"用户中奖次数","list":[{"awardLogId":中奖记录id,"userId":用户id,"accountName":用户名,"realName":真实姓名,"phone":手机号,"address":地址,"zipCode":邮编,"useCredit":抽奖消耗的学分,"awardId":奖品id,"awardName":奖品名,"prizeStatus":领奖状态(0:未领奖,1:已领奖),"awardType":奖品类型,"awardStatus":发奖信息,"createAt":中奖时间,"updateAt":更新时间}]}                

返回参数说明

参数名 参数含义 参数名 参数含义
awardLogId 中奖记录id userId 用户id
accountName 用户名 realName 真实姓名
phone 手机号 address 地址
zipCode 邮编 useCredit 抽奖消耗的学分
awardId 奖品id awardName 奖品名
awardType 奖品类型 awardStatus 发奖信息
createAt 中奖时间 updateAt 更新时间
count 用户中奖次数 prizeStatus 领奖状态(0:未领奖,1:已领奖)

3.2 奖品详情页

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/activityPrizeDetail.xsp

活动后台开发环境: http://v39.pcauto.com.cn:8003/detail.jsp
活动后台线上环境: http://activity.pcauto.com.cn/auto151019/detail.jsp

说明

获取实物奖品记录

缓存时间

提交方式

GET

是否登录

数据来源

活动后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
awardLogId 抽奖记录的id long

返回

HTML

返回参数说明


3.3 每日抽奖页

(开发已完成)

mrobot地址: http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/dailyActivity.xsp

活动后台开发环境: http://v39.pcauto.com.cn:8003/index.jsp
活动后台线上环境: http://activity.pcauto.com.cn/auto151019/index.jsp

说明

每日抽奖

缓存时间

提交方式

GET

是否登录

数据来源

活动后台

参数

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

返回

HTML

返回参数说明