您现在的位置:首页 >
 畅行网接口调用详解

一、概述

1.1 编写说明以及范围

本文档说明主要描述畅行位置服务平台平台对外系统提供的应用接口以及WEB页面,便于客户进行畅行位置服务平台的集成和对接,更方便于客户开发人员对接口的使用。

1.2 承载方式

数据接口调用采用基于HTTP的GET/POST调用方式。

WEB接口采用直接访问页面的调用方式。

1.3 文档导读

为了便于客户阅读使用,在此简要说明

(1)接口类型:数据接口和Web接口。

(2)接口通讯协议及请求方式:基于HTTP的POST方式。

(2)接口请求有效性:客户端请求时间误差为3分钟。

二、接口说明

2.1 参数说明

参数名称 参数类型 必选项 参数描述
account String 帐号名称
time String 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2015-12-03 10:56:10
key String 加密字符串
action String 操作业务名称(即各个接口的方法)
param String 参数说明: 此次请求的任务所需要的参数,通过“;”连接而得到。如需调用车辆的基本信息,则param为type=1;carMark=粤B123456;carMarkColoe=1;

2.2 注意事项

(1)接口的参数名称都要小写,参数值除了特定的都小写

(2)数据编码格式:UTF-8

(3)一些特殊的接口方法返回结果以Web页面呈现

三、接口访问安全控制说明

接口请求时间有效性

外部系统调用API接口时,每次都要传参数时间,允许客户端请求时间误差为3分钟。



数据安全控制

调用接口时需要对请求参数进行验证


调用示例

某个接口的参数如下:

account=admin

time=2015-12-03 15:08:20

key = 178fcfb1b0651693

action=GetCar

param=carids=1,2,3;

key为16位MD5(帐号+32位MD5(密码)+ time)


四、接口详细说明

4.1、基础数据接口

4.1.1、获取车辆基本信息

接口描述

获取用户车辆的最新位置信息

方法名称

GetCarInfo

参数释义
参数名称 参数类型 参数描述
type int 1(固定值,表示按车牌号与车牌颜色查询)
carMark String 车牌号
carMarkColor int 见表1-车牌颜色编码表
carID int 车号
licenceNum int 行驶证号
返回结果详细说明
序号 返回字段 字段说明 示例
1 carId 车号 100000
2 carMark 车牌 粤B123456
3 carMarkColor 车牌颜色 见表1-车牌颜色编码表
4 carColor 车辆颜色 红色
5 carType 车辆类型 客车
6 identificationNum 车架号 LSVAM4187C2184847
7 sim SIM卡 13800138000

4.1.2、司机基本信息

接口描述

获取司机的基本信息

方法名称

GetDriverInfo

参数释义
参数名称 参数类型 参数描述
type int 1(固定值,表示按车牌号与车牌颜色查询)
name String 姓名
tel string 手机号
driverLicense string 驾驶证
driverId string 工号
返回结果详细说明
序号 返回字段 字段说明 示例
1 driverId 工号 100000
2 name 姓名 张三
3 sex 性别
4 idCard 身份证 441624199909090099
5 driverLicense 驾驶证 441624199909090099
6 driverLicenseValid 驾驶证有效期 2019-09-09
7 birthday 出生年月日 2019-09-09
8 tel 手机号 13800138000

4.2、定位数据接口

4.2.1、车辆定位信息

接口描述

获取车辆的实时定位信息

方法名称

GetCarCurrentStatusBycarMark

参数释义
参数名称 参数类型 参数描述
carMarks String 车牌号(如多个车牌请以逗号分隔,粤B1,粤B2,粤B3)
返回结果详细说明
序号 返回字段 字段说明 示例
1 carId 车号 100000
2 carMark 车牌号 粤B123456
3 recordTime 上点时间 2016-02-18 10:10:00
4 location 位置 广东省深圳市南山区大学城东20米
5 last_lon 经度 120.671005
6 last_lat 纬度 28.0030689
7 speed 速度 30(km/h)
8 speedG 定位速度 42(km/h)
9 angle 方向 90
10 flag 方向 见表2- flag编码说明-定位情况
11 isOnline 是否在线 true/false
12 isStarted 是否启动 true/false
13 stoppedTime 停车时长 20(秒)
14 gsm_number SIM卡号 13000000000
15 day_distance 日里程 120(km)
16 month_distance 月里程 900(km)
17 Oil 油耗 50 (L)
18 last_altitude 温度 0 (℃)
19 total_distance 总里程 1500(km)

4.2.2. 历史轨迹

接口描述

获取车辆的历史轨迹信息

方法名称

GetHistoryTrackBycarMark

参数释义
参数名称 参数类型 参数描述
carMark String 车牌号
bTime String 开始时间
eTime String 结束时间
返回结果详细说明
序号 返回字段 字段说明 示例
1 carId 车号 100000
2 carMark 车牌号 粤B123456
3 recordTime 上点时间 2016-02-18 10:10:00
4 location 位置 广东省深圳市南山区大学城东20米
5 last_lon 经度 120.671005
6 last_lat 纬度 28.0030689
7 speed 速度 30(km/h)
8 speedG 定位速度 42(km/h)
9 angle 方向 90
10 flag 方向 见表2- flag编码说明-定位情况
11 isStarted 是否启动 true/false
12 gsm_number SIM卡号 13000000000
13 last_altitude 温度 0 (℃)
14 distance 里程 9(km)
15 Oil 油耗 5 (L)

4.3、警情信息

4.3.1、车辆警情信息

接口描述

获取车辆的警情信息

方法名称

GetCarAlarm

参数释义
参数名称 参数类型 参数描述
carMark String 车牌号
bTime String 开始时间
eTime String 结束时间
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 车牌号 粤B123456
2 alarmType 警情类型 见表3- flag编码说明-报警情况
3 bTime 开始时间 1999-09-09 09:09:09
4 eTime 结束时间 1999-09-09 09:09:09
5 bLocation 开始位置 广东省深圳市南山区大学城东20米
6 eLocation 结束位置 广东省深圳市南山区大学城东20米
7 company 公司 深圳市国脉畅行科技股份有限公司
8 bLongitude 开始经度 120.671005
9 bLatitude 开始纬度 28.0030689

4.4、运营数据

4.4.1、日工作时长统计信息

接口描述

获取车辆的工作时长信息

方法名称

GetCarWorkTime

参数释义
参数名称 参数类型 参数描述
carMark String 车牌号
statisticalDate String 日期
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 车牌号 粤B123456
2 Day_distance 里程 100(km)
3 workTime 工作时长 25分钟

4.4.2、里程信息

接口描述

获取车辆的里程信息

方法名称

GetCarDistance

参数释义
参数名称 参数类型 参数描述
carMark String 车牌号
bTime String 开始时间
eTime String 结束时间
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 车牌号 粤B123456
2 Day_distance 里程 100(km)

4.4.3、车辆违章信息

接口描述

获取车辆的违章信息

方法名称

GetCarIllegalInfo

参数释义
参数名称 参数类型 参数描述
city String 城市代码
Hphm String 号牌号码完整7位
hpzl String 号牌类型
engineno String 发动机号(根据城市接口中的参数填写)
Classno String 车架号(根据城市接口中的参数填写)
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 车牌号 粤B123456
2 illegalType 违章项目 超速
3 illegalTime 违章时间 1999-09-09 09:09:09
4 illegalLocation 违章地点 广东省深圳市南山区大学城东20米

4.5、通讯数据接口

4.5.1、短信数据接口

接口描述

通过短信下发信息

方法名称

SendMessagesByPhone

参数释义
参数名称 参数类型 参数描述
userId String 帐号
key String 安全密钥
tel String 手机号
smsText String 信息内容
返回结果详细说明
序号 返回字段 字段说明 示例
1 respCode 响应状态 表4 -信息发送响应状态码
2 respTime 响应时间 1999-09-09 09:09:09
3 respStatus 响应结果 true/false

4.5.2、微信接口

接口描述

通过微信下发信息

方法名称

SendMessagesByWechat

参数释义
参数名称 参数类型 参数描述
userId String 帐号
key String 安全密钥
wechatId String 微信ID(即加密的openID)
smsTitle String 标题
smsText String 信息内容
smsPerson String 通知人
smsTime String 通知时间
detailUrl String URL(点击详情时的链接地址,为空则链接不生效)
返回结果详细说明
序号 返回字段 字段说明 示例
1 respCode 响应状态 表4 -信息发送响应状态码
2 respTime 响应时间 1999-09-09 09:09:09
3 respStatus 响应结果 true/false

4.5.3、终端信息发送接口

接口描述

通过终端下发信息

方法名称

SendMessagesByTerminal

参数释义
参数名称 参数类型 参数描述
carMark String 车牌号
smsText String 信息内容
返回结果详细说明
序号 返回字段 字段说明 示例
1 flag 响应状态码 表5 -信息发送终端响应状态码
2 respTime 响应时间 1999-09-09 09:09:09
3 respStatus 响应结果 true/false

4.6、物流信息

4.6.1、订单数据接口信息

接口描述

*此接口是位置监控平台向第三方获取数据,建议去掉或不与本文档的其它接口归类* *现在的做法是由海格设计的,且其他客户的数据库与业务逻辑不一样* *只能重用看板的样式,不方便直接使用里面的逻辑*

4.6.2、 物流运力数据接口信息

接口描述

获取物流运力数据信息,包括货运与客运

方法名称

GetLogisticsCapacityInfo

参数释义
参数名称 参数类型 参数描述
type int 表6 –物流运力类型
logisticsCapacityType int 表7 –物流行程类型
placOfDeparture String 出发地
destination String 目的地
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 车牌 粤B123456
2 locateType 定位类型 卫星定位/手机定位
3 locateTime 定位时间 1999-09-09 09:09:09
4 carSpecifications 货箱长/座位数 13.0米/5座
5 carType 车型 挂牵引车
6 carApplication 车辆用途 集装箱运输,海关监管
7 lastLocation 最新位置 广东省深圳市南山区大学城东20米

4.6.3、 物流货/客源数据接口信息

接口描述

获取物流货客源信息

方法名称

GetLogisticsClassifyInfo

参数释义
参数名称 参数类型 参数描述
type int 表8 –物流承运分类
placOfDeparture string 出发地
destination String 目的地
返回结果详细说明
序号 返回字段 字段说明 示例
1 carMark 货物名称/乘客人数 原料/5人
2 placOfDeparture 出发地 广东省深圳市南山区大学城东20米
3 destination 目的地 广东省深圳市南山区大学城东20米
4 carType 车型 半挂牵引车
5 carApplication 车辆用途 集装箱运输,海关监管
6 type 类型 表8 –物流承运分类
7 deliveryInfoTime 信息发布时间 1999-09-09 09:09:09

4.7、基于位置信息匹配接口

4.7.1、获取位置信息

接口描述

通过经纬度返回详细的位置描述

方法名称

GetLocationDescription

参数释义
参数名称 参数类型 参数描述
location String 经纬度
返回结果详细说明
序号 返回字段 字段说明 示例
1 respCode 操作状态 1表示操作成功,其他值均表示操作失败
2 locationDescription 位置描述 深圳市南山区西丽镇大学城

4.7.2、路网接口限速信息

接口描述

通过经纬度与行驶方向返回当前路段的限速阀值

方法名称

GetRoadSpeedLimit

参数释义
参数名称 参数类型 参数描述
lonLat string 经纬度 连续三个点经纬度如 X1,Y1;X2,Y2
times string 时间 连续三个点的utc时间
angles string 方向 连续三个点的方向
speeds string 速度 连续三个点的速度
返回结果详细说明
序号 返回字段 字段说明 示例
1 respCode 操作状态 1表示操作成功,其他值均表示操作失败
2 roadName 道路名称 S33 南光高速
3 roadLevel 道路级别 表9 –道路级别说明
4 maxSpeed 最大时速 100 (km/h)

表1 -《车牌颜色编码表》:

序号 说明
1 1 蓝色
2 2 黄色
3 3 黑色
4 4 白色
5 5 其他

表2 -《flag编码说明-定位情况》:

序号 说明
1 < 128 未定位
2 >=128 定位

表3 -《flag编码说明-报警情况》:

若flag大于等于128,则flag = flag - 128,否则为原值。

序号 说明
1 1 紧急报警
2 4 (终端)超速
3 6 超时停车
4 7 低压
5 8 天线开路
6 10 疲劳驾驶
7 11 主电源断开
8 15 天线短路
9 18 非法移动

表4 -《信息发送响应状态码》:

序号 说明
1 101 帐号错误
2 102 帐号包含非法字符
3 103 Key无效
4 104 请求错误
5 105 网络异常

表5 -《信息发送终端响应状态码》:

序号 说明
1 0 数据成功下发
2 1 终端成功响应
3 2 发送成功
4 3 发送超时
5 99 操作异常

表6 -《物流运力类型》:

序号 说明
1 1 全部车源
2 2 货动车源
3 3 客运车源

表7 -《物流行程类型》:

序号 说明
1 1 回程车
2 2 专线车

表8 -《物流承运分类》:

序号 说明
1 1 全部
2 2 紧急货源
3 3 预约货源
4 4 长期货源
5 5 紧急客源
6 6 预约客源
7 8 长期客源

表9 -《道路级别说明》:

序号 说明
1 101 一般道路
2 102 区县内部道路
3 103 乡村道路
4 104 次要道路(城市次干道)
5 105 县道
6 106 主要道路(城市主干道)
7 107 省道
8 108 城市环路/城市快速路
9 109 国道
10 110 高速公路
11 111 其它道路




粤ICP备09119845号 2006-2017 畅行网 All Rights Reserved