wiki:pcauto_drive_2.3.0/interface

Context Navigation

Version 5 (modified by liguokai, 10 years ago) (diff)
--

学车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": 440100,
            "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"
        },
    ]
}

返回参数说明

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

1.2帖子报名功能

(接口开发中)

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

应用后端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= （获取主贴图片列表）

说明

缓存时间

0

提交方式

GET

是否登录

登录与未登录都可请求

数据来源

论坛&学车后台

参数

参数名	参数含义	类型	默认值	是否必须	说明
tid	帖子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   点击图片协议

1.3 启动图接口

（开发已完成）

mrobot地址：mrobot.pcauto.com.cn/configs/xueche_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": "pcautobrowser://information-article/6840806",
        "vc-uri": "http://192.168.20.6?a=3d",
        "cc-uri": "http://192.168.20.6?a=4d"
    }
}

返回参数说明

参数名	参数含义	参数名	参数含义
delay	延迟显示	interval	间隔显示
age	显示时间	img	图片链接
to-uri	到达页	vc-uri	曝光计数
cc-uri	点击计数

1.2.2 判断用户是否已首次分享

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

学车后台开发环境： http://dev38.pcauto.com.cn:8085/driver/appapi/1.0/getSharedAppTaskStatus.do
学车后台线上环境： http://task.pcauto.com.cn/driver/appapi/1.0/getSharedAppTaskStatus.do

说明

判断用户是否已首次分享

缓存时间

0

提交方式

GET

是否登录

是

数据来源

学车后台

参数

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

{
  "status": "0成功，非0情况为失败或错误"
  "message："失败原因"
  "version"："版本号"

  "taskId"："任务id"
  "haveShare"："是否已分享"
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	接口返回描述信息
haveShare	是否已首次分享过	taskId	任务id

1.2.3 用户赚取学分

非mrobot接口

学车后台开发环境： http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.2#a2.3.考试及格上传分数接口
学车后台线上环境：

说明

用户赚取学分接口

缓存时间

0

提交方式

POST

是否登录

是

数据来源

学车后台

参数

参数名	参数含义	类型	是否必须	说明
Cookie	用户登录cookie	string	是	登录用户cookie，放在请求头中
userId	用户id	string	是	用户id
score	模拟考试分数	int	是

{
    "status": 0,
    "message": "操作成功"
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	接口返回描述信息

1.3学分商城

mrobot地址： http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/scoreMarket.xsp?score=156158

学车后台开发环境：
学车后台线上环境：

说明

学分商城列表

缓存时间

0

提交方式

GET

是否登录

数据来源

参数

参数名	参数含义	类型	默认值	是否必须	说明
score	用户学分	string		否	用户学分

返回HTML页面

返回参数说明

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

协议

点击商品图片跳转到帖子页： pcdrivebrowser://topic-detail/?id=1234
点击登录跳转协议：pcdrivebrowser://user-login
点击跳转至游戏抽奖页: pcdrivebrowser://game

1.4每日抽奖

游戏后台开发环境：
游戏后台线上环境： http://activity.pcauto.com.cn/auto151019/index.jsp

说明

每日抽奖

我的学分/我的奖品

未登录，不显示学分，点击“开始”，跳转到登录页面；
已登录，显示实时学分，点击“我的奖品”进入奖品列表页（奖品列表页由客户端原生）

缓存时间

0

提交方式

GET

是否登录

登录与未登录都可请求

数据来源

参数

参数名	参数含义	类型	是否必须	说明
Cookie	用户登录cookie	string	是	登录用户cookie，放在请求头中
score	用户学分	string	否	用户学分，未登录不传
dev_id
open_udid
app_ver

返回HTML页面

返回参数说明

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

协议

未登录，点击“开始”跳转至登录协议： pcdrivebrowser://user-login
点击我的奖品跳转： pcdrivebrowser://my-prize

1.4.1我的奖品

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

学车后台开发环境：
学车后台线上环境：

说明

我的奖品接口，该接口为预留扩展接口，V2.2版本所有用户返回数据都为空数据

缓存时间

0

提交方式

GET

是否登录

是

数据来源

学车后台

参数

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

{}

返回参数说明

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

2.科目三

2.1科目首页问答接口

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

cms线上环境： http://www.pcauto.com.cn/client/xcbd/1507/intf7331.js

说明

科目首页问答接口

缓存时间

0

提交方式

GET

是否登录

否

数据来源

CMS

参数

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

{
    "status": 0,
    "message": "操作成功",
    "questionList": [
        {
            "id": 440100,
            "title": "离合器半联动怎么找？"
        },
        {
            "id": 434500,
            "title": "科目三怎么踩离合才是正确的？"
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	接口返回描述信息
id	帖子id	title	问答标题

2.2科目首页今日推荐接口

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

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

说明

科目首页今日推荐接口

缓存时间

0

提交方式

GET

是否登录

否

数据来源

CMS

参数

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

{
    "status": 0,
    "message": "操作成功",
    "datas": [
        {
            "title": "文章",
            "id": 440100,
            "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"
        },
    ]
}

返回参数说明

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

2.3 考场实拍，考场列表

mrobot地址： http://mrobot.pcauto.com.cn/xsp/x/xueche.pcauto.com.cn/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100

学车后台开发环境： http://dev38.pcauto.com.cn:8003/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100
学车后台线上环境： http://xueche.pcauto.com.cn/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100

说明

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

缓存时间

0

提交方式

GET

是否登录

否

数据来源

学车后台

参数

参数名	参数含义	类型	默认值	是否必须	说明
cityId	城市id	int	无	是
subjectId	课目ID	int	2	否	（考场是科目二(subjectId=2),路拍是科目三(subjectId=3)）,默认subjectId=2

{
    "code": 0,
    "data": [
        {
            "cityId": 440100,
            "id": 160,
            "name": "秀全驾校",
            "provinceId": 440000,
            "introduction":"",
            "shrinkTagram": [
                {
                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/07/c0/10835360_1438940428057_&1&.jpg"
                }
            ],
            "subjectId":2,
            "py":"X",
            "isGeneral":0
        },
        {
            "cityId": 440100,
            "id": 161,
            "name": "2222",
            "provinceId": 440000,
            "subjectId":2,
            "py":"X",
            "isGeneral":0
        },
        {
            "cityId": 440100,
            "id": 241,
            "name": "测试考场一",
            "provinceId": 440000,
            "introduction":"",
            "shrinkTagram": [
                {
                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/12/c0/11047652_1439347981183.jpg"
                },
                {
                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/12/c0/11047636_1439347990058.jpg"
                }
            ],
            "subjectId":2,
            "py":"X",
            "isGeneral":0
        }
    ],
    "message": "操作成功",
    "version": "v1.0(latest)"
}

返回参数说明

参数名	参数含义	参数名	参数含意
cityId	城市id	id	考场id
name	考场名称	provinceId	省份id
shrinkTagram	图片	introduction	描述
subjectId	科目id	isGeneral	是否公用

2.4 考场详情页（web页）

mrobot地址： http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/examAreaDetail.xsp?id=241&resVer=21000&platform=iphone&isShare=1

学车后台开发环境： http://dev38.pcauto.com.cn:8003/appapi/1.0/examArea/getExamAreaById.do?id=
学车后台线上环境： http://xueche.pcauto.com.cn/appapi/1.0/examArea/getExamAreaById.do?id=

说明

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

缓存时间

0

提交方式

GET

是否登录

否

数据来源

学车后台

资源包存放路径

http://dev40.pcauto.com.cn:8002/configs.jsp
http://dev40.pcauto.com.cn/configs/pcauto_iphone_xueche_examAreaDetail.json
http://dev40.pcauto.com.cn/configs/pcauto_android_xueche_examAreaDetail.json

参数

参数名	参数含义	类型	是否必须	说明
id	考场id	int	是
platform	设备类型	string	是	iphone,android
resVer	资源包版本	string	是	版本号由app同事定
isShare	是否分享	int	是	1：出分享页；0：出详情页

返回HTML页面

注释：

/*@_HTML_META_START_ {"resVer":"21001","shareUrl":" http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/examAreaDetail.xsp? id=241&resVer=21000&platform=iphone&isShare=1","firstImg":" http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/12/c0/11047637_1439348002343_600x450.jpg"} _HTML_META_END_@*/

返回参数说明

参数名	参数含义	参数名	参数含意
resVer	资源包版本号	shareUrl	分享url
firstImg	第一张图片

协议

图片跳转： pcdrive://big-photo?url=

2.5基础知识

mrobot地址： http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/basicKnowledge.xsp?id=6483971

cms开发环境： http://test2.pcauto.com.cn:8002/interface/pcauto/mrobot_articles_v5.jsp?id=6483971
cms线上环境： http://192.168.10.74:8003/interface/pcauto/mrobot_articles_v5.jsp?id=6483971

说明

获取基础知识主页

缓存时间

分钟

提交方式

GET

是否登录

否

数据来源

cms

参数

参数名	参数含义	类型	默认值	是否必须
id	文章id	int		是

{
    "author": "moyingchao",
    "id": "6483971",
    "image": "",
    "image2": "",
    "pageNum": 7,
    "preView": "各位都知道，科目二是需要上车实操的，到了考试时，考员有必要提前调节好车内的东西，",
    "pubDate": 1439369785713,
    "tagWords": [],
    "tags": [
        {
            "pageNo": 2,
            "picText": [
                {
                    "pic": "http://img0.pcauto.com.cn/pcauto/1508/10/6866928_14_thumb.jpg",
                    "text": "● 车门开关　　将后视镜调整到自己日常练车的位置，以便自己找到熟悉的感觉。    啊岁的老将阿隆索大家啊三季度刻录机啊斯达康洛吉拉斯简单快乐"
                }
            ],
            "tagName": "车门开关"
        }
     ],
    "title": "科目二基础操作测试用",
    "url": "http://www.pcauto.com.cn/techtest/648/6483971.html",
    "wapUrl": "http://m.pcauto.com.cn/x/648/6483971.html"

}

返回参数说明

参数名	参数含义	参数名	参数含意
author	作者	id	文章id
pageNum	页数	image	图片
preView	概述	pubDate	发布日期
pageNo	页码	pic	文章图
text	文章内容	tagName	标签
title	标题	url	pc端链接
wapUrl	wap链接

2.6 夜考、完整版

mrobot地址： http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/articles.xsp?id=6483971&resVer=21000&platform=iphone&type=1

cms开发环境： http://test1.pcauto.com.cn:8002/interface/pcauto/mrobot_articles_v3.jsp?id=6483971
cms线上环境： http://192.168.10.74:8003/interface/pcauto/mrobot_articles_v3.jsp?id=6483971

说明

获取cms录入的考试文章

缓存时间

分钟

提交方式

GET

是否登录

否

数据来源

cms

资源包存放路径

http://dev40.pcauto.com.cn:8002/configs.jsp
http://dev40.pcauto.com.cn/configs/pcauto_iphone_xueche_articles.json
http://dev40.pcauto.com.cn/configs/pcauto_android_xueche_articles.json

参数

参数名	参数含义	类型	默认值	是否必须	说明
pageNo	页数	int	1	否
allText	是否出全文	int	0	否	为1时返回全文内容
id	文章ID	string		是	应用端需要
platform	设备类型	string		是	iphone,android
resVer	资源包版本	string		是	版本号由app同事配置
type	页面类型	string		是	1：文章终端页，2：倒车入库，3：必过版（除倒车入库）
isTarget	跳转难点攻克	int		否	为1时跳转到难点攻克

返回HTML页面

注释：

/*@_HTML_META_START_ {"resVer":"21001","shareUrl":"","firstImg":" http://img0.pcauto.com.cn/pcauto/1508/06/6502326_4_thumb.jpg"} _HTML_META_END_@*/

返回参数说明

参数名	参数含义	参数名	参数含意
resVer	资源包版本号	shareUrl	分享url
firstImg	第一张图片

协议

图片跳转： pcdrive://big-photo?url=
小游戏： pcdrive://game

3.0 邀请码

3.1 注册设备号

非mrobot接口

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

说明

注册设备号接口，app启动后将设备id传至学车后台，post成功后不再请求

缓存时间

0

提交方式

POST

是否登录

否

数据来源

学车后台

参数

参数名	参数含义	类型	是否必须	说明
deviceCode	设备id	string	是	设备id
timeStamp	时间戳	string	是	时间戳
token	md5加密	string	是	md5(密钥+时间戳+密钥+设备ID)

{
    "status": 0,
    "message": "操作成功"
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	接口返回描述信息

3.2 获取邀请码页面

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

学车后台开发环境： http://dev38.pcauto.com.cn:8003/appapi/1.0/invite/getInvite.do

http://dev38.pcauto.com.cn:8003/appapi/1.0/invite/getMyInviteCount.do

学车后台线上环境： http://xueche.pcauto.com.cn/appapi/1.0/invite/getInvite.do

http://xueche.pcauto.com.cn/appapi/1.0/invite/getMyInviteCount.do

说明

获取邀请码页面

缓存时间

0

提交方式

GET

是否登录

是

数据来源

学车后台

参数

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

{
    "code": 0,
    "message": "操作成功",
    "thisMonthInviteCount": 0,
    "totalInviteCount": 0,
    "totalInviterAmount":0,
    "version": "v1.0(latest)",
    "inviteId": 11,
    "shareUrl": "http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/getInvitation.xsp?code=11"
}

返回参数说明

参数名	参数含义	参数名	参数含义
thisMonthInviteCount	本月邀请人数	totalInviteCount	累计邀请人数
inviteId	邀请码	shareUrl	分享链接
totalInviterAmount	总共获得邀请的学分

3.3 填写邀请码

非mrobot接口

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

说明

填写邀请码接口

缓存时间

0

提交方式

POST

是否登录

是

数据来源

学车后台

参数

参数名	参数含义	类型	是否必须	说明
Cookie	用户登录cookie	string	是	登录用户cookie，放在请求头中
deviceCode	设备id	string	是	设备id
inviteId	邀请码	string	是	邀请码
agent	来自平台	int	是	来自平台：2iOS，3安卓
accountId	用户id	string	是	用户id

{
    "status": 0,
    "message": "邀请成功"
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	邀请成功与否的提示信息

4.0 优化点

4.1 点赞接口

非mrobot接口

学车后台开发环境： http://rdtrac.pc.com.cn/xueche/wiki/appapi/2.2#a4.1点赞
学车后台线上环境：

说明

如果不是那8个学车论坛的帖子，是不能点赞的。

缓存时间

0

提交方式

POST

是否登录

是

数据来源

学车后台

参数

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

{
    "code" : 0,
    "message": "操作成功",
    "version": 1.0,
}

返回参数说明

参数名	参数含义	参数名	参数含义
code	0成功，-1失败，-2未登录,-3贴子不存在（学车找不到贴子，就是不属于学车8个板块）	message	接口返回描述信息
version	接口版本号如1.0，1.0（latest)表示最新版本

4.2 取消点赞接口

非mrobot接口

学车后台开发环境： http://rdtrac.pc.com.cn/xueche/wiki/appapi/1.2#a1.2.6取消点赞
学车后台线上环境：

说明

如果不是那8个学车论坛的帖子，是不能取消点赞的。1.2取消点赞接口新增字段判断是否属于8个论坛的帖子

缓存时间

0

提交方式

POST

是否登录

是

数据来源

学车后台

参数

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

{
    "status": 0,
    "message": "操作成功",
    "version": 1.0,
    "fromForum": true
}

返回参数说明

参数名	参数含义	参数名	参数含义
status	接口返回状态码：0成功，非0异常	message	接口返回描述信息
version	接口版本号如1.0，1.0（latest)表示最新版本	fromForum	新增字段，判断是否来自8个论坛

Download in other formats:

Plain Text

Context Navigation

Table of Contents

学车2.3.0接口文档 (建立此页，内容待修改)

1.cms与论坛

1.1科目一首页焦点图

1.2帖子报名功能

1.3 启动图接口

1.2.2 判断用户是否已首次分享

1.2.3 用户赚取学分

1.3学分商城

1.4每日抽奖

1.4.1我的奖品

2.科目三

2.1科目首页问答接口

2.2科目首页今日推荐接口

2.3 考场实拍，考场列表

2.4 考场详情页（web页）

2.5基础知识

2.6 夜考、完整版

3.0 邀请码

3.1 注册设备号

3.2 获取邀请码页面

3.3 填写邀请码

4.0 优化点

4.1 点赞接口

4.2 取消点赞接口

Download in other formats: