Changes between Initial Version and Version 1 of pcauto_4.7.4/interface


Ignore:
Timestamp:
09/08/2015 05:04:41 PM (11 years ago)
Author:
liguokai
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pcauto_4.7.4/interface

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