Changes between Initial Version and Version 1 of pcauto_drive_2.2.0/interface


Ignore:
Timestamp:
09/10/2015 02:21:34 PM (11 years ago)
Author:
lianchijin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pcauto_drive_2.2.0/interface

    v1 v1  
     1[[TOC]] 
     2 
     3= 学车2.2.0接口文档 = 
     4>mrobot代理环境说明:  
     5     192.168.10.198 端口为 1080 连的是QA测试环境(192.168.74.80)[[BR]]  
     6     192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)[[BR]]  
     7     '''ps:对于mrobot.pcauto.com.cn/x/前缀的接口,mrobot仅作代理,没有任何逻辑处理。''' [[BR]]  
     8     制作地址: [[BR]]  
     9     应用后端接口trac: 
     10== 1.学分任务与商城 == 
     11---------- 
     12 
     13 
     14=== 1.1我的 === 
     15'''(V1.1版本 2.7获取个人信息接口增加返回用户学分字段)'''[[BR]] 
     16>mrobot地址:http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/getPersonalinf.xsp [[BR]] 
     17 
     18**说明** 
     19 
     20> 获取个人信息接口增加返回用户学分字段[[BR]] 
     21 
     22**缓存时间** 
     23 
     24>分钟 
     25 
     26**提交方式** 
     27 
     28> GET 
     29 
     30**是否登录** 
     31 
     32> 是 
     33 
     34**数据来源** 
     35 
     36>  
     37 
     38**参数** 
     39 
     40||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
     41||= Cookie =||= 用户登录cookie =|| string ||=  =||= 是 =||= 登录用户cookie,放在请求头中 =|| 
     42 
     43**返回** 
     44 
     45{{{#!java 
     46{ 
     47      "code": 0, 
     48      "gender": 0, 
     49      "message": "成功", 
     50      "address": "", 
     51      "drivingSchool": "未报考驾校", 
     52      "drivingSchoolId": -2, 
     53      "nickName": "hahahahahaha", 
     54      "userId": 31836836, 
     55      "cityName": "", 
     56      "cityId": 0 
     57      "score":用户学分(新增字段) 
     58} 
     59}}} 
     60 
     61**返回参数说明** 
     62||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     63||= score =||= 用户学分(新增字段) =||= =||==|| 
     64 
     65---------- 
     66 
     67== 2.考场 == 
     68---------- 
     69 
     70 
     71=== 2.1考场城市列表 === 
     72'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     73>mrobot地址: http://mrobot.pcauto.com.cn/xsp/x/xueche.pcauto.com.cn/appapi/1.0/examArea/listExamArea.do [[BR]] 
     74学车后台开发环境:http://dev38.pcauto.com.cn:8003/appapi/1.0/examArea/listExamArea.do [[BR]] 
     75学车后台线上环境:http://xueche.pcauto.com.cn/appapi/1.0/examArea/listExamArea.do [[BR]] 
     76 
     77**说明** 
     78 
     79> 获取已知考场的城市列表 
     80 
     81**缓存时间** 
     82 
     83>0 
     84 
     85**提交方式** 
     86 
     87> GET 
     88 
     89**是否登录** 
     90 
     91> 否 
     92 
     93**数据来源** 
     94 
     95>学车后台 
     96 
     97**参数** 
     98 
     99||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =|| 
     100 
     101**返回** 
     102 
     103{{{#!java 
     104{ 
     105    "code": 0, 
     106    "data": [ 
     107        { 
     108            "cityId": 440100, 
     109            "cityName": "广东" 
     110        } 
     111    ], 
     112    "message": "操作成功", 
     113    "version": "v1.0(latest)" 
     114} 
     115}}} 
     116**返回参数说明** 
     117||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     118||= cityId =||= 城市id =||=cityName=||=城市名称=|| 
     119 
     120 
     121 
     122=== 2.2考场列表 === 
     123'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     124>mrobot地址:http://mrobot.pcauto.com.cn/xsp/x/xueche.pcauto.com.cn/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100 [[BR]] 
     125学车后台开发环境:http://dev38.pcauto.com.cn:8003/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100 [[BR]] 
     126学车后台线上环境:http://xueche.pcauto.com.cn/appapi/1.0/examArea/listExamAreaByCity.do?cityId=440100 [[BR]] 
     127 
     128**说明** 
     129 
     130> 获取某个城市下的考场列表 
     131 
     132**缓存时间** 
     133 
     134>0 
     135 
     136**提交方式** 
     137 
     138> GET 
     139 
     140**是否登录** 
     141 
     142> 否 
     143 
     144**数据来源** 
     145 
     146>学车后台 
     147 
     148**参数** 
     149 
     150||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =|| 
     151||= cityId =||= 城市id =||= int =||= 无 =||= 是 =||= =|| 
     152 
     153**返回** 
     154 
     155{{{#!java 
     156{ 
     157    "code": 0, 
     158    "data": [ 
     159        { 
     160            "cityId": 440100, 
     161            "id": 160, 
     162            "name": "秀全驾校", 
     163            "provinceId": 440000, 
     164            "shrinkTagram": [ 
     165                { 
     166                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/07/c0/10835360_1438940428057_&1&.jpg" 
     167                } 
     168            ] 
     169        }, 
     170        { 
     171            "cityId": 440100, 
     172            "id": 161, 
     173            "name": "2222", 
     174            "provinceId": 440000 
     175        }, 
     176        { 
     177            "cityId": 440100, 
     178            "id": 241, 
     179            "name": "测试考场一", 
     180            "provinceId": 440000, 
     181            "shrinkTagram": [ 
     182                { 
     183                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/12/c0/11047652_1439347981183.jpg" 
     184                }, 
     185                { 
     186                    "url": "http://img.pcauto.com.cn/images/upload/upc/tx/driver/1508/12/c0/11047636_1439347990058.jpg" 
     187                } 
     188            ] 
     189        } 
     190    ], 
     191    "message": "操作成功", 
     192    "version": "v1.0(latest)" 
     193} 
     194}}} 
     195**返回参数说明** 
     196||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     197||= cityId =||= 城市id =||=id=||=考场id=|| 
     198||= name =||= 考场名称 =||=provinceId=||=省份id=|| 
     199||= shrinkTagram =||= 图片 =||==||==|| 
     200 
     201 
     202 
     203=== 2.3考场详情页(web页) === 
     204'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     205>mrobot地址:http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/examAreaDetail.xsp?id=241&resVer=21000&platform=iphone&isShare=1 [[BR]] 
     206学车后台开发环境:http://dev38.pcauto.com.cn:8003/appapi/1.0/examArea/getExamAreaById.do?id= [[BR]] 
     207学车后台线上环境: http://xueche.pcauto.com.cn/appapi/1.0/examArea/getExamAreaById.do?id= [[BR]] 
     208 
     209**说明** 
     210 
     211> 获取学车后台录入的考场详情。 
     212 
     213**缓存时间** 
     214 
     215>0 
     216 
     217**提交方式** 
     218 
     219> GET 
     220 
     221**是否登录** 
     222 
     223> 否 
     224 
     225**数据来源** 
     226 
     227>学车后台 
     228 
     229**资源包存放路径** 
     230> http://dev40.pcauto.com.cn:8002/configs.jsp [[BR]] 
     231> http://dev40.pcauto.com.cn/configs/pcauto_iphone_xueche_examAreaDetail.json [[BR]] 
     232> http://dev40.pcauto.com.cn/configs/pcauto_android_xueche_examAreaDetail.json [[BR]] 
     233  
     234**参数** 
     235 
     236||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =|| 
     237||= id =||= 考场id =||= int =||=  =||= 是 =||=  =|| 
     238||= platform =||=设备类型 =||= string =||=  =||= 是 =||= iphone,android =|| 
     239||= resVer =||=资源包版本 =||= string =||=  =||= 是 =||= 版本号由app同事定 =|| 
     240||= isShare =||= 是否分享 =||= int =||=  =||= 是 =||= 1:出分享页;0:出详情页 =|| 
     241 
     242**返回** 
     243 
     244返回HTML页面 
     245 
     246注释: 
     247        /*@_HTML_META_START_ 
     248        {"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"} 
     249        _HTML_META_END_@*/ 
     250 
     251**返回参数说明** 
     252||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     253||= resVer =||= 资源包版本号 =||=shareUrl =||=分享url=|| 
     254||= firstImg =||= 第一张图片 =||==||==|| 
     255 
     256**协议** 
     257> 图片跳转: pcdrive://big-photo?url= [[BR]] 
     258---------- 
     259 
     260== 3.基础知识 == 
     261---------- 
     262 
     263 
     264=== 3.1基础知识主页 === 
     265'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     266>mrobot地址:http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/basicKnowledge.xsp?id=6483971 [[BR]] 
     267cms开发环境:http://test1.pcauto.com.cn:8002/interface/pcauto/mrobot_articles_v5.jsp?id=6483971 [[BR]] 
     268cms线上环境:http://192.168.10.74:8003/interface/pcauto/mrobot_articles_v5.jsp?id=6483971 [[BR]] 
     269 
     270**说明** 
     271 
     272> 获取基础知识主页 
     273 
     274**缓存时间** 
     275 
     276>分钟 
     277 
     278**提交方式** 
     279 
     280> GET 
     281 
     282**是否登录** 
     283 
     284> 否 
     285 
     286**数据来源** 
     287 
     288>cms 
     289 
     290**参数** 
     291 
     292||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     293||= id =||= 文章id =||= int=||=  =||= 是 =|| 
     294 
     295**返回** 
     296 
     297{{{#!java 
     298{ 
     299    "author": "moyingchao", 
     300    "id": "6483971", 
     301    "image": "", 
     302    "image2": "", 
     303    "pageNum": 7, 
     304    "preView": "各位都知道,科目二是需要上车实操的,到了考试时,考员有必要提前调节好车内的东西,", 
     305    "pubDate": 1439369785713, 
     306    "tagWords": [], 
     307    "tags": [ 
     308        { 
     309            "pageNo": 2, 
     310            "picText": [ 
     311                { 
     312                    "pic": "http://img0.pcauto.com.cn/pcauto/1508/10/6866928_14_thumb.jpg", 
     313                    "text": "● 车门开关  将后视镜调整到自己日常练车的位置,以便自己找到熟悉的感觉。    啊岁的老将阿隆索大家啊三季度刻录机啊斯达康洛吉拉斯简单快乐" 
     314                } 
     315            ], 
     316            "tagName": "车门开关" 
     317        } 
     318     ], 
     319    "title": "科目二基础操作测试用", 
     320    "url": "http://www.pcauto.com.cn/techtest/648/6483971.html", 
     321    "wapUrl": "http://m.pcauto.com.cn/x/648/6483971.html" 
     322 
     323} 
     324 
     325}}} 
     326 
     327**返回参数说明** 
     328||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     329||= author =||= 作者 =||=id=||=文章id=|| 
     330||= pageNum =||= 页数 =||=image=||=图片=|| 
     331||= preView =||= 概述 =||=pubDate=||=发布日期=|| 
     332||= pageNo =||= 页码 =||=pic=||=文章图=|| 
     333||= text =||= 文章内容 =||=tagName=||=标签=|| 
     334||= title =||= 标题 =||=url=||=pc端链接=|| 
     335||= wapUrl =||= wap链接 =||==||==|| 
     336 
     337---------- 
     338 
     339== 4.五大项目 == 
     340---------- 
     341 
     342 
     343=== 4.1五大图集 === 
     344'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     345>mrobot地址:http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/picGroup.xsp?groupId=2506 [[BR]] 
     346图库开发环境:http://dev31.pconline.com.cn:8042/intf/group_photo.jsp?groupId=2506  [[BR]] 
     347图库线上环境:http://beauty.pcauto.com.cn/pcautophoto/intf/group_photo.jsp?groupId=2506  [[BR]] 
     348 
     349**说明** 
     350 
     351> 获取图集内容 
     352 
     353**缓存时间** 
     354 
     355>无 
     356 
     357**提交方式** 
     358 
     359> GET 
     360 
     361**是否登录** 
     362 
     363> 否 
     364 
     365**数据来源** 
     366 
     367>图库后台 
     368 
     369**参数** 
     370 
     371||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||==|| 
     372||groupId||图集id||string||""||是||==|| 
     373 
     374**返回** 
     375 
     376{{{#!java 
     377{ 
     378    "cover": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s_medium.jpg", 
     379    "desc": "最牛停车场! 汽车坠楼全过程 更多图片请点击进入:http://bbs.pcauto.com.cn/topic.jsp?tid=1168108来源:PCauto网友 为人民服务", 
     380    "groupId": 2506, 
     381    "name": "最牛停车场! 汽车坠楼全过程 ", 
     382    "number": 1, 
     383    "photos": [ 
     384        { 
     385            "desc": "", 
     386            "name": "", 
     387            "photoId": 62051, 
     388            "sourceUrl": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s.jpg", 
     389            "thumbUrl": "http://img1.pcauto.com.cn/piclib/200901/21/batch/1/21509/1232502807393xpv6jmzx3s_small.jpg" 
     390        } 
     391    ] 
     392} 
     393 
     394}}} 
     395**返回参数说明** 
     396||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     397||= cover=||= 封面图=||= desc=||=描述=|| 
     398||= groupId=||=图集id=||= name=||=标题=|| 
     399||= number=||=图片数量=||= photoId=||=图片id=|| 
     400||= sourceUrl=||=图片链接=||= thumbUrl=||=缩略图链接=|| 
     401 
     402 
     403 
     404=== 4.2问答栏目 === 
     405'''(mrobot已完成,请连开发机进行测试)'''[[BR]] 
     406> mrobot地址:http://mrobot.pcauto.com.cn/xsp/s/auto/info/xueChe/questionList.xsp?type=1 [[BR]] 
     407cms栏目开发环境:http://www.pcauto.com.cn/client/xcbd/1508/intf7491.html [[BR]] 
     408cms栏目线上环境:http://www.pcauto.com.cn/client/xcbd/1508/intf7491.html [[BR]] 
     409 
     410**说明** 
     411 
     412> 获取问答栏目列表 
     413 
     414**缓存时间** 
     415 
     416> 0 
     417 
     418**提交方式** 
     419 
     420> GET 
     421 
     422**是否登录** 
     423 
     424> 否 
     425 
     426**数据来源** 
     427 
     428>cms栏目录入 
     429 
     430**参数** 
     431 
     432||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     433||= type =||= 项目类型 1:倒车入库,2:侧方停车,3:斜坡起步,4:曲线行驶,5:直角转弯 =||= int =||=  =||= 必须 =|| 
     434**返回** 
     435 
     436{{{#!java 
     437{ 
     438    "subjectName": "倒车入库", 
     439    "data": [ 
     440        { 
     441            "title": "倒车入库车身压线,到底是什么原因?", 
     442            "url": "pcautobrowser://bbs-topic/8103337", 
     443            "type": false, 
     444            "answerCount": 0, 
     445            "browseCount": 0 
     446        }, 
     447        { 
     448            "title": "倒车入库车身压线,到底是什么原因?怎样才能避免这种情况再出现啊?", 
     449            "url": "pcautobrowser://bbs-topic/8103337", 
     450            "type": false, 
     451            "answerCount": 0, 
     452            "browseCount": 0 
     453        }, 
     454        { 
     455            "title": "倒车入库车身与库角30CM怎么判断呢?", 
     456            "url": "pcautobrowser://bbs-topic/8110447", 
     457            "type": false, 
     458            "answerCount": 0, 
     459            "browseCount": 0 
     460        } 
     461    ] 
     462} 
     463}}} 
     464**返回参数说明** 
     465||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
     466||= subjectName =||= 项目名称 =||=title=||=帖子标题=|| 
     467||= url =||= 帖子链接 =||=type=||=(false代表普通问答,true代表精华问答)=|| 
     468||= answerCount =||= 回复数 =||=browseCount=||=浏览数=|| 
     469 
     470=== 4.3五大必过版 === 
     471'''使用1.1考试文章终端页(web页)接口:'''[[BR]] 
     472[http://trac.pc.com.cn/iphone/wiki/pcauto_drive_2.1.0/interface#a1.1考试文章终端页web页] 
     473 
     474 
     475---------- 
     476 
     477== 5分享 == 
     478=== 5.1图集分享(后端线上已有接口,制作增加下载头部) === 
     479图库开发环境:[[BR]] 
     480图库线上环境:http://beauty.pcauto.com.cn/pcautophoto/template/pcauto_bbs/wap/photo.jsp?groupId=10766 [[BR]] 
     481> 非mrobot接口 
     482 
     483**说明** 
     484 
     485>分享图集,wap版 
     486 
     487**缓存时间** 
     488 
     489>0 
     490 
     491**提交方式** 
     492 
     493>GET 
     494 
     495**是否需要登录** 
     496 
     497>否 
     498 
     499**数据来源** 
     500 
     501> 图库后台 
     502 
     503**参数** 
     504 
     505||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     506||groupId||图集id||int||无||是|| 
     507||sd||是否显示下载头部||int||无||是(学车宝典app要传1,显示学车宝典下载头)|| 
     508 
     509**返回** 
     510 
     511返回HTML页面 
     512 
     513**返回参数说明** 
     514||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||