wiki:pcauto_drive_2.3.0/interface

Version 28 (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"
        },
    ],
   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每日抽奖
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": "pcdrive://bbs-topics/8650721",
        "vc-uri": "http://192.168.20.6?a=3d",
        "cc-uri": "http://192.168.20.6?a=4d",
        "type":"2",
        "comment":"type取值---->1:文章页;2:话题详情页;3:专题页面;4:游戏页面;5:每日抽奖;6:专家在线。to-uri---->论坛:pcdrive://bbs-topics/8650721;文章:pcdrive://info-articles/8650721;其他:直接填URL"
    }
}

返回参数说明

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

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添加专家在线页标记


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

说明

科目首页专家在线接口

缓存时间

0

提交方式

GET

是否登录

数据来源

CMS

参数

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

返回

{
    "status": 0,
    "message": "操作成功",
    "questionList": [
        {
            "id": 440100,
            "title": "离合器半联动怎么找?"
        },
        {
            "id": 434500,
            "title": "科目三怎么踩离合才是正确的?"
        }
    ],
    "questionSpecial": [
        {
             "specialUrl": "http://m.pcauto.com.cn/auto/k/online/eo/a272/",
             "specialTitle": "教练在线解答"
         }
    ]
}

返回参数说明

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

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 父类(type=0时,查询一级分类,type>0时,是查询该类型的下一级分类)
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:马上兑换,1:已达兑换上限,2:分数不足
        }
}

返回参数说明

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

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失败
        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失败
        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地址:

bip开发环境:
bip线上环境:

说明

获取消息列表

缓存时间

提交方式

GET

是否登录

数据来源

BIP

参数

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

返回

返回参数说明

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

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版。


3.活动

每日抽奖模块活动部门开发中,敬请期待...