中鼎车载GPS北斗监管系统

1、中鼎车载GPS北斗监管系统(20160508 版)开放接口概述ZHONHDIN 平台致力开放平台建设，提供的接口包含：ZHONHDIN平台GServer实时接口 -可以连接GServer服务器程序，获取监控车辆数据，下发实时命令等等；ZHONHDIN开放平台动态数据接口-可以返回车辆当前位置数据、轨迹回放数据等车辆动态信息;ZHONHDIN开放平台静态数据接口-提供增加客户、19 / 92帐号、分组、车辆等修改静态数据的接口； ZHONHDIN平台数据库字典-开放对ZHONHDIN平台后台数据库所有数据表的定义及说明;ZHONHDIN平台其他接口 -其他一些面向行业应用的接口。如果我们b5E2

2、RGbC提供 的接口不能满足你的需要，可以联系技术支持反应，我们将开放更多接口。、ZHONHDIN平台GServer实时接口 (JSON)ZHONHDIN 平台 GServer 实时接口（JSON）GServer实时接口 JSON)说明:本规范规定了直接接入 ZHONHDIN平台GServer应用服务器的接口定义，采用TCP通讯方式，实现了用户登录、权限验证、各种数据传输等功能。P 1EanqFD本规范主要用来实现第三方软件和GServer服务器实时互通，采用TCP传输方式，端口为1502，数据格式使用json格式。DXDiTa9E数据分为数据头(header)和数据体(body)两个部分。数

3、据头(header)部分格式为:header:cmd:1000格式主要包含一个命令字(cmd)属性，程序根据命令字来区分数据体的内容。数据体(body)部分包含的数据会根据数据头中的命令字(cmd)而异。RTCrpUDG第三方平台数据转入 ZHONHDIN平台步骤:获取一个ZHONHDIN平台帐号以TCP方式登录ZHONHDIN平台1502端口，参考用户登录命令 1000等待ZHONHDIN平台登录返回成功，如果返回结果不是success服务器将掐断TCP连接收到成功后，第三方平台需要间隔30秒发送心跳消息，参看客户端心跳1002连接成功后，第三方平台可以按照车辆定位数据1007格式上传车辆数

4、据第三方平台退出连接可以发送用户退出1001命令，然后断开TCP连接自己开发客户端接入 ZHONHDIN平台GServer服务器步骤:获取一个ZHONHDIN平台帐号以TCP方式登录ZHONHDIN平台1502端口，参考用户登录命令 1000等待ZHONHDIN平台登录返回成功，如果返回结果不是success服务器将掐断TCP连接收到成功后，第三方平台需要间隔30秒发送心跳消息，参看客户端心跳1002请求下发用户下客户和分组数据1008请求下发每个分组下的车辆数据1010服务器向客户端转发车辆的实时定位数据1007客户端向车载终端下发车机命令1003客户端退出连接，发送退出命令1001，然后断

5、开TCP连接5PCZVD7H1.用户从客户端登录 GServer服务器数据发送方向:client server命令字：1000参数参数类型说明n ameString用户名称p assString用户密码ver;String客户端版本，如 4.6936typeString客户端类型 ison commonmode；Stri ng备用，填空格式：header:cmd:1000,body:name:ZHONHDIN,p ass:000000.ver:ty pe:.mode:jLBHrnAI2. 服务器对客户端发送命令返回的通用应答数据发送方向：server client命令字：8000参数：参数类型

6、说明cmdString服务器接收到的命令字resultString结果success 成功 failed失败格式:header:cmd:8000,body:cmd:1000,result:success XHAQX74J3. 用户从客户端退出/注销登录数据发送方向：client server命令字：1001 参数:参数类型说明header:cmd:1001，body:data: LDAYtRyK4. 客户端向服务器发送心跳消息数据发送方向：client server命令字：1002客户端登录成功后，需要按照 30秒间隔向服务器发送心跳消息，如果3分钟没有收到客户端发送的心跳消息，服务器端将主动

7、断开客户端的连接 Zzz6ZB2L参数:result格式:header:cmd:1002,body:result: dvzfvkwM参数类型说明Stri ng5. 服务器向客户端发送通知消息数据发送方向：client server命令字：1003参数:msg参数Stri ng类型消息内容说明格式:header:cmd:1003，body:msg: rqyn14ZN6. 客户端向车载终端发送车机命令数据发送方向：client server命令字：1003参数:msg命令格式为:7000v/idvp aram180v/p aramvp aram10参数Stri ng类型命令格式说明v/p aram

8、 v/cmd 参考 cmd.xml 文件 EmxvxOtO格式:header:cmd:1003，body:msg: SixE2yXP7. 服务器向客户端转发车辆实时定位数据数据发送方向：server client命令字：1007参数:参数类型说明codeString车牌号码idStri ng车辆IDlatStri ng纬度lngStri ng经度veoStri ng速度dirStri ng方向gpstimeStri ng格式为：2011-11-01 12:38:39avStri ng表示是否为有效疋位，0无效定位，1有效定位alarmStri ng是否报警，0无报警，1报警，oilString

9、当前油量disStri ng当前总里程wstateStri ng整数类型状态cstateStri ng状态描述，可以为空pos infoStri ng位置描述，可以为空P1Stri ng模拟量1p2Stri ng模拟量2格式:header:cmd:1007，body:code:,id:,lat:.Ing:,veo:dir:,gp stime:,av:,alarm:,oil:,dis:,wstate:,cstate:,p osinfo:p 1:p 2: 6ewMyirQ8. 客户端请求服务器下发用户权限下客户及分组数据数据发送方向：client server命令字：1008 参数:clie nt

10、参数类型说明Stri ngtrue下发客户关系数据,false不下发格式:header:cmd:1008，body:client:true kavU42VR9.服务器向客户端下发用户的客户、分组数据数据发送方向：client server命令字：1009参数:参数类型groupidstri ngfelati onstri ngcustomerstri nggoupn amestri ng车辆分组的ID用户的客户分组的客户分组名称说明格式:header:cmd:1009,body:grou pid:.relation:,customer:,gou pname: y6v3ALoS10.客户端请求服

11、务器下发用户权限下分组的车辆数据数据发送方向：client server命令字：1010参数:参数类型说明groupidStri ng车辆分组ID格式:header:cmd:1010,body:grou pid:1 M2ub6vST11.服务器向客户端下发用户权限下指定分组的车辆静态数据数据发送方向：server client命令字：1011参数类型idStri ng车辆IDcodeStri ng车牌号码simStri ngSIM卡号码termi nalidStri ng终端设备IDgroupn ameStri ng车辆所属分组名称vhctypeStri ng车辆类型mobilet ypeSt

12、ri ng终端设备类型参数:格式:说明header:cmd:1011,body:id:,code:,Sim:,terminalid:.group name:.vhcty pe:.mobilet yp e: 0YujCfmU12.客户端发送车机透传命令到设备命令字：1012参数：参数类型termi nalidStringcodeStringcmdidStringcmdpassStringdataString设备ID车牌号码透传命令密码，一般为空数据发送方向：client server说明命令ID,透传命令固定为7513透传数据的16进制字符串格式:header:cmd:1012,body:ter

13、minalid:,code:,cmdid:,cmd pass:.data: eUts8ZQV13.服务器转发车载终端的透传数据到客户端数据发送方向：server client命令字：1013 参数:参数类型说明16进制字符串header:cmd:1013，body:terminalid:.code:,data: sQsAEJkW、动态数据接口ZHONHDIN 平台动态数据接口接口说明ZHONHDIN开放平台增加动态数据接口，主要以JSON格式返回车辆当前位置数据、轨迹回放数据等等车辆动态信息GMslasNX(1)信息内容为json格式，必须采用 UTF-8编码。(建议提交方式为 post方法，

14、可以避免汉字乱码问题)TIrRGchY(2)错误代码解释 success:false,errorT yp e:6 success false :请求失败 true :请求成功errorType : 0 :系统出错 1 :方法名不存在 2 :版本号不存在 3 :参数不能为空 4 :参数值格式有误 5 :用户名或密码错误 6 :授权码无效 7 :超过一小时最大访问次数7EqZcWLZ(3)如果接口请求地址不存在,请联系技术支持更新服务器。用户登录请求参数versionmethodn amepwd参数In tegerStri ngStri ngStri ng类型必须版本号方法用户名密码说明HTTP请

15、求例子:1:89/gpsonline/GPSAPI ?version=1 &method=loginSystem&name=sunya n&pwd=123456lzq7IGfO服务器响应参数类型说明versionIn teger版本号successBoolea n是否成功uidIn teger用户IDuKeyStri ng用户授权码返回格式：version.success:true,uid:2103811.uKey:4cb75a5b8ea89966691535021db029fb zvpgeqJ1车辆登录请求参数参数类型必须说明versionIn teger是

16、版本号methodStri ng是方法n ameStri ng是车牌号码pwdStri ng是密码HTTP请求例子: 1:89/gpsonline/GPSAPI?version=1 &method=vLoginSystem&name=辽 HB929&pwd=000000 NrpoJac3服务器响应versionsuccessvidvKey参数In tegerBoolea nIn tegerStri ng类型版本号是否成功车辆ID车辆授权码说明返回格式:version.success:true,vid:4103747,vKey:2e8b868d779f1e1c0

17、696e04113e79003 1nowfTG4分组车辆数据请求参数参数类型必须说明versionIn teger是版本号methodStri ng是方法uidString是用户IDuKeyString是用户授权码HTTP请求例子：htt p:/1:89/g psonline/G PSAP l?version=1 &method=loadVehicles&uid=2103811 &uKey=4cb75a5b8ea89966691535021db029fbfjnFLDa5服务器响应参数类型说明versionIn teger版本号successBoolea n是否成功gro

18、ups:分组groups参数参数类型说明id|ln teger分组IDn ameStri ng分组名称vehicles车辆vehicles 参数参数类型说明idIn teger车辆IDn ameStri ng车牌号码vKeyStri ng车辆授权码返回格式：version.success:true.groups:id:3012222.name:私车,vehicles:id:4103780.name:辽 G53609new,vKey:0470beb71bc7214db501067ae4c2aeb6, tfnNhnE6车辆最新位置请求参数参数类型必须说明versionIn teger是版本号met

19、hodStri ng是方法vidIn teger是车辆IDvKeyStri ng是车辆授权码HTTP请求例子:htt P： /1:89/g psonline/G PSAP l?version=1 &method=loadLocation&vid=4103747&vKey=2e8b868d779f1e1c0696e04113e7 9003HbmVN777服务器响应参数类型说明versionIn teger版本号successBoolean是否成功locs位置locs参数参数类型说明idn teger车辆IDn ameDString车牌号码recvtimeIn teger服务

20、器时间（毫秒数）gp stimeIn tegerGPS时间（毫秒数）latDouble纬度lngDouble经度16 / 92stateStri ng车辆状态sp eedDouble速度directn teger方向tempDouble温度oilDouble油量oilMN1n teger模拟量1oilMN2n teger模拟量2dista neeDouble行驶里程totalDis1Double总里程avString有效性infoStri ng文字位置信息vhcoffl ineminn teger不在线时长（分钟）sto pDefDis1Double设防距离sto pDefLat1Double

21、设防纬度stop DefL ng1Double设防经度tempi!String温度1temp21String温度2temp3Stri ng温度3temp4String温度4lng_xzDouble返回格式：lat_xzDouble纬度修正值经度修正值version.success:true,Iocs:id:4103747.name:辽 HB929 ,recvtime:1375867746000.gp stime:1375867680000,lat:40.77228,lng:122.27882,lat_xz:0.001645,lng_xz:0.005182.state:防劫报警 停车超时报警（7

22、h11m）? ,sp eed:O,direct:336.tem p:-50.oil:0.oilMN1:0,oilMN2:0,distance:62.4.totalDis:22559.44,av:1,info:辽宁省营口市大石桥市加油站西南1673米1,vhcofflinemin:10.sto pDefDis:0,sto pDefLat:0,sto pDefLng:0,temp 1:0.0,tem p2:0.0.temp 3:0.0,tem p4:0.0 V7l4jRB8轨迹回放请求参数参数类型必须说明versionIn teger是methodStri ng是vidIn teger是vKeyS

23、tri ng是bTimeIn teger是eTimeIn teger是版本号方法车辆ID车辆授权码开始时间（毫秒数）结束时间（毫秒数）HTTP请求例子: h卄p:/61 157 96 61:89/gpsonline/GPSAPI?Version=1 &method=loadHistory&vid=4103747&VKey=2e8b868d779f1e1c0696e04113e79 003&bTime=1375459200000&eTime=1375545599000 83lcPA5967 / 92服务器响应versionsuccesshistory参数类型说明In teger版本号Boolea

24、n是否成功:历时轨迹参数类型说明avString有效性dir|n teger方向disDouble里程gp stStri ngGPS时间idIn teger车辆IDlatDouble纬度lat_xzDouble纬度修正值lngDouble经度lng xzDouble经度修正值oilDouble油量p1In teger模拟量1p2In teger模拟量2photoStri ng照片路径pos infoStri ng文字位置信息recvtStri ng服务器时间stateStri ng状态tempDouble温度totaldista neeDouble总里程veoDouble速度history 参

25、数:返回格式：version.success:true.history:av:1,d:330.dis:O,gp st:2013-08-03 00:00:30,id:18215,lat:40.662804.lat_xz:0.001645.lng:122.250465,lng_xz:0.005182,oil:0,p 1:0,p 2:0,p hoto:.posinfo:辽宁省营口市站前区桂丰园小区西105米1,recvt:2013-08-03 00:01:29,state:防劫报警停车（24m）,tem p:-50.totaldistance:22250.303,veo:0, mZkklkza车辆地

26、图位置接口 功能介绍:第三方软件（如：ERP、OA等内部管理软件）可以通过传入车牌号码在地图上获取车辆当前位置信息。URL接口地址: httP：/XX.XX.XX.XX :89/lnterface/findPosition.action?carNum=车牌号码 AVktR43b（注：这里的车牌号码需为完整正确的车牌号码。） 女n： 1:89/lnterface/findPosition.action?carNum= 京 G41064 天顺 &u=gbk ORjBnOwc:遍%噪义匿孝桶殳中心抄学车牌： 司机I 电话； 时间！ 状态： 速度： 位置：201 03

27、-21 1 3:1 0:00 0停车超时报嘗（18M3m）0.5北京市顺义区绪貪路首钢氧气厂气体产业基地西北2咪5301n,静态数据接口显示全部2MiJTy0d用户登录gliSpiue 修改密码（管理员监控员）uEh0U1Yf 修改密码（个人账号）IAg9qLsg 添加客户WwghWvVh 删除客户asfpsfpi 修改客户ooeyYZTj 查询客户BkeGuI nk添加分组PgdOOsRI删除分组3cdXwckm修改分组h8c52WOn查询分组v4bdyGio添加车辆J0bm4qMp删除车辆XVauA9gr修改车辆bR9C6TJs查询车辆PN9LBDdt查询车辆所属分组 DJ8T7nHu增加

28、用户QF81D7bv删除用户4B7a9QFw修改用户ix6iFA8x查询用户wt6qbkCy查询用户所属分组 Kp5zH46z添加用户所属分组 Yl4HdOAA数据字典ch4PJX4BZHONHDIN 平台静态数据接口注：为了保证系统的安全性和稳定性,若一个账号连续五次密码错误，则该账户会被冻结2小时，2小时后可进行登录。qd3YfhxC用户登录(1)只验证登录成功与否请求URL :htt P： /vi p4.ZHONHDIN.cn/synthRe ports/mobile_to_synth/zdyloginAction_autologin.actionE836L11D请求参数参数类型pu s

29、er.userNamestring用户名pu ser.user Pwdstring用户密码pu ser.serverIdstring服务器ptint值=1(没有此参数密码属于加密值P user.userName=*&p user.userPwd=*&p user.serverld=*&p t=*S42ehLvE说明服务器响应提示信息用户信息数组用户id待用会话IDdata: id: 2025,是否成功登录说明登录加密key （登录成功后，每次传入exkey=xxxx类似sessionid作用）data_sql:jsessionid: -Py08RGDJMY2xMm Pe0gqSw_exkey:

30、 501nNvZF（2 ）验证登录成功同时返回权限模块数据 请求URL :是否成功登录htt p:/vi p4.ZHONHDIN.cn/synthRe ports/re ports_to_synth/zdyloginAction_autologin.actionjW1viftGmsgstri ng提示信息dataarr用户信息数组参数类型说明puser.userNameking用户名pu ser.user Pwdking用户密码pu ser.serverIdstri ng服务器ptint值=1（没有此参数密码属于加密值）puser.userName=*&p user.userPwd=*&p u

31、ser.serverld=*&p t=*xS0DOYWH服务器响应参数类型说明请求参数flagboolea ndata-idiintdata_sqlstri ngjsessi onidstri ngexkeystri ngmlarrml-idntml-namestri ng待用会话ID权限模块数组模块标识值模块名称用户id登录加密key （登录成功后，每次传入exkey=xxxx类似sessionid作用）返回格式：flag: true,msg:,data: id: 2025,data_sql:,jsessionid: -Py08RGDJMY2xM mP e0gqSw_,exkey:,ml:

32、id: 100000,name:监控管理,id: 101000,name: 客户管理儿exkey: LOZMkIql修改密码（管理员监控员） 请求URL :htt p:/vi p4.ZHONHDIN.cn/synthRe ports/mobile_to_synth/zdyloginAction_edit Password.action ?p user.userPwd=*&new Pwd1=*& new Pwd2=*&exkey=*ZKZUQsUJ请求参数参数类型说明pu ser.userPwdstring旧密码new Pwd1string新密码new Pwd2string再次确认新密码exke

33、ystri ng登录成功后返回的 exkey（可省略）服务器响应flag参数Boolea n类型是否成功说明msgdatastri ngAE返回提示信息返回格式flag: true,msg:,data:,修改密码（个人账号） 请求URL :dGY2mcoKhtt P： /vi p4.ZH0NHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction _p erEdit Password.action ?p user.userName=*&p use r.id=*&p user.userPwd=*&new Pwd仁*&new Pwd2=*&

34、p user.serverld=*请求参数参数类型说明pu ser.userNamestri ng个人账号名称（设备名称）pu ser.idnt个人帐号ID（设备ID）pu ser.user Pwdstri ng旧密码new Pwd1stri ng新密码new Pwd2stri ng再次确认新密码pu ser.serverIdint所在服务器IDexkeystri ng登录成功后返回的 exkey（可省略）服务器响应参数类型说明flagBoolea n是否成功msgstri ng返回提示信息dataArr无返回格式flag: true,msg:,data:,添加客户 请求URL :rCYbSW

35、RLhtt p:/vi p4.ZHONHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_add.action?tableName=client&client.co mpy name=* *&client .p hone=*&client.officeaddrs=*&exkey=*请求参数参数类型说明tableNameStri ngclie ntclie nt.co mpyn amestri ng企业名称clie nt. phoneStri ng企业联系电话clie nt.officeaddrsStri ng办公地址exkeySt

36、ri ng登录成功后返回的exkey（可省略）服务器响应参数类型说明flagBoolea n是否成功msgstring返回提示信息data sqlLtring待用data,Arr客户信息数组idnt客户Id返回格式:flag: true,msg:,data:id:*.data_sql: FyXjoFIM删除客户 请求URL :htt p:/vi p4.ZH0NHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_del.action?tableName=client&client.id=*&exkey =* TuWrUpPO请求参数

37、参数类型说明参数类型说明tableNameStri ngclie ntclie nt.idstri ng客户IdexkeyStri ng登录成功后返回的 exkey（可省略）服务器响应flagBoolea n是否成功msgstring返回提示信息data_sqlLtring待用data,Arr客户信息数组idnt客户Id返回格式flag: true,msg:,data:id:*.data_sql: 7qWAq9j P修改客 请求URL :llVIWTNQhtt p: /vi p4.ZHONHDIN.cn/synthRe poils/mobile_to_synth/mobileTosynthAc

38、tion_u pdate.action?tableName=client&client.id=*&cli ent.co mp yname=*&client. phone=*&client.officeaddrs=*&exkey=*请求参数tableNameclie nt.id参数类型Stri ngclie ntclie nt.co mpyn ame说明Stri ngstri ng客户Id企业名称die nt. phone企业联系电话clie nt.officeaddrsexkeyStri ng办公地址登录成功后返回的 exkey（可省略）服务器响应flagmsgdataiddata_sql参数

39、类型说明Boolea n是否成功stri ng返回提示信息Arr客户信息数组int客户Idstring待用返回格式flag: true,msg:,data_sql: yhUQsDgR查询客户 请求URL :MdUZYnKShtt p:/vi p4.ZHONHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_find.action?tableName=client&p ager.offset=O&p ageSize=8 &p ro=co mpy name&p va=test &exkey=*请求参数参数类型说明tableNameSt

40、ringclie ntP ager.offsetint起始行数（分页，可省略，即查询所有数据）p ageSizeint每页行数（分页）prostring查询字段名称（compyname）可省略pvaString查询条件值（可省略）exkeyString登录成功后返回的 exkey（可省略）服务器响应flagmsgtotalCou ntdataidcompyn amecompypersonphoneofficeaddrs参数Boolea nstri ngintArrintstri ngStri ngStri ngStri ng类型是否成功返回提示信息客户记录数量客户信息数组客户Id企业名称企业法

41、人代表企业联系电话办公地址说明返回格式flag: true,msg:,data:id:13405,com pyname:*,co mpyp erson:*, phone:*,officeaddrs:* 09T7t6eT添加分组 请求URL :e5TfZQIUhtt p: /vi p4.ZHONHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_add.action?tableName=gro up&group .gro up Name=* *&grou p.userCount=*&grou p.vhcCount=*&userld=

42、*&exkey=*请求参数tableName参数类型说明group.groupN amegroup. userC ountgroup. vhcCo untuserIdexkeyStringStri ngintintintStri ng用户数量车辆数量所属客户（可以省略默认为0）登录成功后返回的exkey（可省略）服务器响应flag参数Boolea n类型是否成功说明msg返回提示信息dataiddata_sqlArr分组信息数组nt分组IdStri ng待用stri ng返回格式flag: true,msg:,data_sql: s1SovAcV删除分组请求URL :htt p:/vi p4.

43、ZH0NHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_del.action?tableName=grou p& group .id=*&exkey=* GXRw1kFW请求参数参数类型说明tableNameStri nggroupgroup .idnt分组IdexkeyStri ng登录成功后返回的 exkey（可省略）服务器响应参数flagmsgdataiddata_sql类型说明Boolea n是否成功String返回提示信息Arr分组信息数组int分组IdStri ng待用返回格式flag: true,msg:,data_sql: UTREx49X修改分组 请求URL :8PQN3NDYhtt p: /vi p4.ZH0NHDIN.cn/synthRe ports/mobile_to_synth/mobileTosynthAction_u pdate.action?tableName=grou p&grou p.id=*&gr oup .grou pName=*&group .userCount=*&grou