乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 1 / 70
乐高易车联网平台接口体系
目录
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 2 / 70
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 3 / 70
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 4 / 70
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 5 / 70
接口体系
平台提供restful风格的接口,接口调用安全遵守OAuth2.0认证协议,调用接口时必须通过Http请求头传递用户标识及其认证令牌。如:
Authorization:Bearer d2pqOjEyMzQ1Ng==
其中“d2pqOjEyMzQ1Ng”为token字符串。
接口返回结果为json格式(application/json)。返回结果数据结构如下:
返回参数说明:
参数名称
必须
类型
说明
code
是
Integer
返回结果,0:成功;1:失败;9:权限不足
message
是
String
返回结果提示信息
data
是
Object
返回结果
返回json示例:
元数据接口
元数据接口属于框架层面的通用接口,提供了基于实体的CURD操作,为标准的RESTful风格接口。
获取对象列表
请求路径:
GET ${host}/system/objects
请求参数:
无
返回参数:
{
"code":0,
"message":"success",
"data":{
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 6 / 70
参数名称
类型
说明
desc
string
对象描述
entityName
string
对象名称
collectionName
string
对象集合名称
请求例子:
GET https://api.legaoyi.com/system/objects.json
获取对象描述
请求路径:
GET ${host}/system/object/{entityName}/description
请求参数:
参数名称
必须
类型
说明
entityName
是
String
路径参数,实体名称
返回参数:
对象描述信息
请求例子:
GET https://api.legaoyi.com/system/object/device/description.json
获取消息描述
请求路径:
GET ${host}/system/message/{messageId}/description
请求参数:
参数名称
必须
类型
说明
messageId
是
String
路径参数,消息id
返回参数:
消息描述信息
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 7 / 70
请求例子:
GET https://api.legaoyi.com/system/message/0200/description.json
获取消息样例
请求路径:
GET ${host}/system/message/{messageId}/example
请求参数:
参数名称
必须
类型
说明
messageId
是
String
路径参数,消息id
返回参数:
消息样例信息
请求例子:
GET https://api.legaoyi.com/system/message/0200/example.json
查询对象记录
对象记录列表查询接口,根据给定的实体名称和查询条件查询对象数据。根据对象数据的存储所用的数据库(mysql、mongodb),查询条件稍有不同,具体参考以下介绍。
请求路径:
POST ${host} /common/query/{entityName}.json
请求参数:
参数名称
必须
类型
说明
entityName
是
String
路径参数,实体名称
select
否
String
url参数,返回字段信息(对应实体对象字段名称),逗号分隔
countable
否
Boolean
url参数,是否需要返回分页参数(可选值:ture、 false)
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 8 / 70
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
对于关系型数据库(mysql)
form参数格式:
参数名称
必须
说明
{fieldName}.gt
否
{fieldName} > ?
{fieldName}.gte
否
{fieldName} >= ?
{fieldName}.lt
否
{fieldName} < ?
{fieldName}.lte
否
{fieldName} <= ?
{fieldName}.eq
否
{fieldName} = ?
{fieldName}.neq
否
{fieldName} <> ?
{fieldName}.like
否
{fieldName} like '%?%'
对于mongodb数据库:
form参数格式:
参数名称
必须
说明
recordDate
是
数据存放时间yyyyMMdd格式(由于mongodb中部分数据是按天分表存放,这部分数据需要传此参数)
conditions
否
普通查询条件,支持and查询,key-value值,支持gt,gte,lt,lte,eq操作
rangeConditions
否
范围查询条件(如时间段查询)
conditions参数格式:
参数名称
必须
说明
{fieldName}.gt
否
{fieldName} > ?
{fieldName}.gte
否
{fieldName} >= ?
{fieldName}.lt
否
{fieldName} < ?
{fieldName}.lte
否
{fieldName} <= ?
{fieldName}.eq
否
{fieldName} = ?
rangeConditions参数格式:
参数名称
必须
说明
fieldName
否
{fieldName}
from
否
范围开始值
includeLower
否
是否等于开始值,true or false
includeUpper
否
是否等于范围截止值,true or false
to
否
范围截止值
返回结果:
返回对象记录列表,如果没有匹配的结果,则返回一个空的数组。
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 9 / 70
请求例子:
POST https://api.legaoyi.com/common/query/user.json?select=id,name&orderBy=createTime
POST消息体(mysql查询条件):
POST消息体(mongodb查询条件):
获取对象记录
获取指定ID的指定对象记录,返回对象记录详情。
请求路径:
GET ${host}/common/{entityName}/{id}.json
请求参数(application/json):
{
"userId .gt":1,
"userName.like":"test",
"type.eq":1
}
{
"conditions":{
"userId .gt":1,
"userName.like":"test",
"type.eq":1
},
"rangeConditions":[
{
"fieldName":"gpsTime",
"from":"2016-12-12",
"includeLower":true,
"includeUpper":true,
"to":"2016-12-13"
}
]
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 10 / 70
参数名称
必须
类型
说明
entityName
是
String
路径参数,实体名称
id
是
string
路径参数,记录id
返回参数:
对象记录详情,如果没有匹配的结果,则返回空。
请求例子:
GET https://api.legaoyi.com/common/user/1.json
新增对象记录
新增对象记录详情。
请求路径:
POST ${host}/common/{entityName}.json
请求参数:
参数名称
必须
类型
说明
entityName
是
string
路径参数,实体名称
form
是
Object
post消息体参数(json格式),实体对象记录详情,key-value值
返回参数:
添加成功后的记录详情。
请求例子:
POST https://api.legaoyi.com/common/user.json
POST消息体:
{
"userName":"test",
"type":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 11 / 70
修改对象记录
根据给定的ID修改指定的对象记录。
请求路径:
PATCH ${host}/common/{entityName}/{id}.json
请求参数:
参数名称
必须
类型
说明
entityName
是
String
路径参数,实体名称
id
是
string
路径参数,记录
form
是
Object
post消息体参数(json格式),实体对象记录详情,key-value值
返回参数:
修改成功后的记录详情。
请求例子:
PATCH https://api.legaoyi.com/common/user/1.json
POST消息体:
删除对象记录
删除对象记录。
请求路径:
DELETE ${host}/common/{entityName}/{ids}.json
请求参数:
参数名称
必须
类型
说明
entityName
是
String
路径参数,实体名称
ids
是
String
路径参数,记录id列表,逗号分隔
返回参数:
{
"userName":"test",
"type":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 12 / 70
无
注:关联的实质可能被级联删除,取决于JPA标注和数据库表的外键约束情况。
请求例子:
DELETE https://api.legaoyi.com/common/user/1,2,3.json
业务接口
业务接口提供给外部系统的restful定制化接口,实现特定的逻辑。一般情况下,为了减少业务接口,如果通用接口可以实现的数据操作,则应不提供或者尽量少提供定制化的业务接口。
获取token接口
请求路径:
GET ${host}/ oauth2/token.json
请求参数:
参数名称
必须
类型
说明
grant_type
是
string
路径参数,值为password 或者 phone
username
是
string
路径参数,
grant_type=password时为用户名称;
grant_type=phone时为手机号码
password
是
string
路径参数,
grant_type=password时为经过AES加密后的用户密码;
grant_type=phone时为手机验证码
返回参数:
参数名称
类型
说明
access_token
string
token
refresh_token
string
刷新token,用于过期前获取新的token
scope
string
操作权限
token_type
string
值为Bearer
expires_in
string
过期时间,单位为分钟
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 13 / 70
请求例子:
GET https://api.legaoyi.com/ /oauth2/token.json?grant_type=password&username=test&password=ecM4pCU0VV0xnlhACrb1Tg
刷新token接口
请求路径:
GET ${host}/ oauth2/token.json
请求参数:
参数名称
必须
类型
说明
grant_type
是
string
路径参数,值为refresh_token
refresh_token
是
string
路径参数,刷新token
返回参数:
参数名称
类型
说明
access_token
string
token
refresh_token
string
刷新token,用于过期前获取新的token
scope
string
操作权限
token_type
string
值为Bearer
expires_in
string
过期时间,单位为分钟
请求例子:
GET https://api.legaoyi.com/ /oauth2/token.json?grant_type=refresh_token& refresh_token=ecM4pCU0VV0xnlhACrb1Tg
身份认证接口
请求路径:
GET ${host}/aas/authentication.json
请求参数:
无
返回参数:
参数名称
类型
说明
id
string
用户id
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 14 / 70
name
string
用户名称
account
string
用户登录账号
type
Integer
用户类型
state
Integer
用户状态
enterpriseId
string
用户所属企业id
lastLoginTime
string
用户最后登录时间
roleId
string
用户角色id
permissions
List
用户权限列表
permissions.
id
string
功能id
permissions.
code
string
功能代码
permissions. roleId
string
角色id
permissions.
name
string
功能名称
permissions.
actions
json
具有的操作权限列表
请求例子:
GET https://api.legaoyi.com/aas/authentication.json
获取下级组织信息接口
请求路径:
GET ${host}/aas/subsidiary.json
请求参数:
无
返回参数:
返回下级企业对象“Enterprise”详情列表。
请求例子:
GET https://api.legaoyi.com/aas/subsidiary.json
获取设备状态接口
请求路径:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 15 / 70
GET ${host}/device/{id}/state.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,设备id列表,逗号分隔
返回参数:
参数名称
类型
说明
state
integer
设备状态,
0:未注册;
1:已注册;
2:离线;
3:在线;
4:已注销;
5:已停用
id
string
设备id
请求例子:
GET https://api.legaoyi.com/device/1,2,3/state.json
获取设备业务状态接口
请求路径:
GET ${host}/device/{id}/bizState.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,设备id列表,逗号分隔
返回参数:
参数名称
类型
说明
state
integer
业务状态:
0:离线;
1:行驶;
2:停车;
3:熄火;
4:无信号
id
string
设备id
请求例子:
GET https://api.legaoyi.com/device/1,2,3/bizState.json
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 16 / 70
获取设备信息接口
请求路径:
GET ${host}/device/{id}.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,设备id
返回参数:
返回设备对象“Device”详情
请求例子:
GET https://api.legaoyi.com/device/1.json
获取设备绑定的车辆信息接口
请求路径:
GET ${host}/device/{id}/car.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,设备id列表,逗号分隔
返回参数:
返回“DeviceCar”对象详情。
请求例子:
GET https://api.legaoyi.com/device/1/car.json
获取设备终端参数信息接口
请求路径:
GET ${host}/device/{id}/terminal/params.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,设备id
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 17 / 70
返回参数:
参数名称
类型
说明
请求例子:
GET https://api.legaoyi.com/device/1/terminal/params.json
获取车辆状态接口
请求路径:
GET ${host}/car/{id}/state.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,车辆id列表,逗号分隔
返回参数:
参数名称
类型
说明
state
integer
设备状态,
0:未注册;
1:已注册;
2:离线;
3:在线;
4:已注销;
5:已停用
carId
string
车辆id
请求例子:
GET https://api.legaoyi.com/car/1/state.json
获取车辆业务状态接口
请求路径:
GET ${host}/car/{id}/bizState.json
请求参数:
参数名称
必须
类型
说明
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 18 / 70
id
是
string
路径参数,车辆id列表
返回参数:
参数名称
类型
说明
state
integer
业务状态:
0:离线;
1:行驶;
2:停车;
3:熄火;
4:无信号
carId
string
车辆id
请求例子:
GET https://api.legaoyi.com/device/1,2,3/bizState.json
解绑车辆设备接口
请求路径:
DELETE ${host}/car/device/{deviceId}.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
返回参数:
无
请求例子:
DELETE https://api.legaoyi.com/car/device/1.json
获取设备当前的司机信息接口
请求路径:
GET ${host}/device/driver/{deviceId}.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
返回参数:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 19 / 70
返回司机对象“Driver”详情。
请求例子:
GET https://api.legaoyi.com/device/driver/1.json
获取车辆当前的司机信息接口
请求路径:
GET ${host}/car/driver/{carId}.json
请求参数:
参数名称
必须
类型
说明
carId
是
string
路径参数,车辆id
返回参数:
返回司机对象“Driver”详情。
请求例子:
GET https://api.legaoyi.com/car/driver/1.json
获取未绑定司机的车辆列表接口
请求路径:
POST ${host}/driver/car/unbind.json
请求参数:
无
返回参数:
参数名称
类型
说明
id
string
车辆id
enterpriseId
string
车辆所属企业id
plateNumber
string
车牌号
plateColor
Integer
车牌颜色
请求例子:
GET https://api.legaoyi.com/driver/car/unbind.json
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 20 / 70
指令下发接口
平台向车载设备发送指令。
请求路径:
POST ${host}/command/{deviceId}/{messageId}.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
messageId
是
String
路径参数,消息ID(参考乐高易网关使用手册中对应消息id的定义)
form
是
Object
post消息体参数(json格式),
协议网关定义消息体(参考乐高易网关使用手册中对应消息体的定义),key-value值
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/command/5/9101.json
POST消息体:
批量指令下发接口
平台向车载设备发送指令。
请求路径:
POST ${host}/batch/command/{messageId}.json
请求参数:
参数名称
必须
类型
说明
{
"channelId":1,
"dataType":0,
"streamType":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 21 / 70
messageId
是
String
路径参数,消息ID(参考乐高易网关使用手册中对应消息id的定义)
form
是
Object
post消息体参数(json格式),
协议网关定义消息体(参考乐高易网关使用手册中对应消息体的定义),key-value值
deviceIds
是
string
ost消息体参数,设备id列表,多个设备id之间“,”逗号分隔
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/batch/command/9101.json
POST消息体:
指令状态查询接口
根据指令id查询指令的下发的状态。
请求路径:
GET ${host}/command/{id}/state.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,指令记录id列表,多个(最多10个)可用“,”分隔
返回参数:
参数名称
必须
类型
说明
id
是
string
指令记录id
state
是
integer
指令状态,
0:终端设备应答成功;
1:终端设备应答失败;
2:终端应答消息有误;
3:终端应答消息不支持;
{
"deviceIds":"1,2,3",
"channelId":1,
"dataType":0,
"streamType":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 22 / 70
4:消息已下发;
5:终端设备已下线;
6:消息有误;
7:不支持该消息;
8:网关处理中;
9:终端应答超时
请求例子:
GET https://api.legaoyi.com/command/1/state.json
开启实时音视频传输指令接口
平台向车载设备发送开启实时音视频传输指令。
请求路径:
POST ${host}/command/{deviceId}/9101.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
dataType
是
int
post消息体参数,数据类型
0:音视频
1:视频
2:对讲
3:监听
streamType
是
int
post消息体参数,码流类型,
0:主码流
1:子码流
返回参数:
参数名称
类型
说明
id
string
指令记录id
streamId
string
视频流id,用作心跳保持
flvUrl
string
http-flv拉流地址
rtmpUrl
string
rtmp拉流地址
hlsUrl
string
https-flv拉流地址(暂不支持)
talkUrl
string
对讲推流wss地址,按照1078协议格式把采集到的pcm(8khz,16位,单通道)数据封装成字节流
请求例子:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 23 / 70
POST https://api.legaoyi.com/command/5/1/9101.json
POST消息体:
视频心跳保持接口
前端应用开始播放视频时,定时(每隔5秒)调用该接口保持心跳,否则后台会自动关闭视频。
请求路径:
PUT ${host}/video/heartbeat/{streamId}.json
请求参数:
参数名称
必须
类型
说明
streamId
是
string
路径参数,视频流id
返回参数:
无
请求例子:
PUT https://api.legaoyi.com/video/heartbeat/1.json
POST消息体:
实时音视频传输控制指令接口
平台向车载设备发送实时音视频传输控制指令。
请求路径:
{
"channelId":1,
"dataType":0,
"streamType":1
}
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 24 / 70
PUT ${host}/command/{deviceId}/9102.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
command
是
post消息体参数,控制指令
0:关闭音视频
1:切换码流
2:暂停播放
3:恢复播放
4:关闭对讲
dataType
是
int
post消息体参数,关闭音视频类型
0:关闭全部
1:关闭音频,保留视频
2:关闭视频,保留音频
streamType
是
int
post消息体参数,码流类型,
0:主码流
1:子码流
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
PUT https://api.legaoyi.com/command/5/9102.json
POST消息体:
历史视频资源查询指令接口
平台向车载设备发送历史视频资源查询指令。平台会每天定时发送指令查询设备昨天的历史视频资源列表,但不包括今天在内。所以前端应用需要查询今天的历史视频资源时需要先发送改指令获取今天的历史视频资源列表,待车载设备应该成功之后,在调用“查询历史视频资源”接口即可获取历史视频资源列表。对于查询昨天的历史视频资源列表可发可不发送该指令。
请求路径:
POST ${host}/command/{deviceId}/9205.json
{
"channelId":1,
"command":0,
"dataType":0,
"streamType":0
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 25 / 70
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号,0代表查询全部通道
streamType
是
int
post消息体参数,码流类型:
0:所有码流
1:主码流
2:子码流
storeType
是
int
post消息体参数,存储器类型:
0:所有存储器
1:主存储器;
2:灾备存储器
resourceType
是
int
文件类型:
0:音视频
1:音频
2:视颊;
3:音频或视频
startTime
是
string
开始时间,格式:yyyy-MM-dd:hh:mm:ss
endTime
是
string
结束时间,格式:yyyy-MM-dd:hh:mm:ss
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/command/5/9205.json
POST消息体:
查询30天内是否存在历史视频资源接口
请求路径:
GET ${host}/video/hisVideoResource/{deviceId}/check/last30days.json
请求参数:
{
"channelId":0,
"streamType":0,
"storeType":0,
"resourceType":0,
"startTime":"2022-05-30 00:00:00",
"endTime":"2022-05-31 00:00:00"
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 26 / 70
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
否
Integer
URL参数,通道id,不传递则默认全部通道
返回参数:
参数名称
类型
说明
date
String
日期,格式:yyyy-MM-dd
exists
Boolean
是否存在视频资源,true 存在;false:不存在
请求例子:
GET https://api.legaoyi.com/video/hisVideoResource/5/check/last30days.json? channelId=1
通过资源id开启录像回放指令接口
平台向车载设备发送开启录像回放指令。
请求路径:
POST ${host}/command/playback/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
参数名称
类型
说明
id
long
指令记录id
flvUrl
string
http-flv拉流地址
rtmpUrl
string
rtmp拉流地址
hlsUrl
string
http-hls拉流地址(暂不支持)
请求例子:
POST https://api.legaoyi.com/command/playback/1.json
POST消息体:
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 27 / 70
开启录像回放指令接口
平台向车载设备发送开启录像回放指令。
请求路径:
POST ${host}/command/{deviceId}/9201.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
playbackType
是
int
post消息体参数,回放方式
0:正常回放;
1:快进回放;
2:关键帧快退回放;
3:关键帧播放;
4:单帧上传;
playTimes
是
int
post消息体参数,快进或快退倍数
回放控制为1和2时,此字段内容有效,否则置0。
0;无效;
1 :1倍;
2:2倍;
3:4倍;
4:8倍;
5:16倍
startTime
是
string
post消息体参数,开始回放位置
格式:yyyy-MM-dd:hh:mm:ss,
回放控制为4时,表示单帧上传时间
endTime
是
string
post消息体参数,结束回放位置
格式:yyyy-MM-dd:hh:mm:ss,
bizId
是
Long
资源文件id
返回参数:
参数名称
类型
说明
id
string
指令记录id
flvUrl
string
http-flv拉流地址
rtmpUrl
string
rtmp拉流地址
hlsUrl
string
https-flv拉流地址(暂不支持)
请求例子:
POST https://api.legaoyi.com/command/{deviceId}/{type}/9201.json
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 28 / 70
POST消息体:
录像回放控制指令接口
平台向车载设备发送录像回放控制指令。
请求路径:
post ${host}/command/{deviceId}/9202.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
playbackType
是
int
post消息体参数,回放方式
0:开始回放;
1 :暂停回放;
2:结束回放;
3:快进回放;
4:关键帧快退回放;
5:拖动回放;
6:关键帧播放
playTimes
是
int
post消息体参数,快进或快退倍数
回放控制为3和4时,此字段内容有效,否则置0。
0;无效;
1 :1倍;
2:2倍;
3:4倍;
4:8倍;
5:16倍
{
"channelId":1,
"dataType":1,
"streamType":0,
"storeType ":1,
"playbackType":0,
"startTime":"2022-06-27 00:00:00",
"endTime":"2022-06-27 59:59:59",
"bizId":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 29 / 70
startTime
是
string
post消息体参数,拖动回放位置
格式:yyyy-MM-dd:hh:mm:ss,
回放控制为5时,此字段有效
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/command/5/9202.json
POST消息体:
停止录像回放指令接口
平台向车载设备发送停止录像回放指令。
请求路径:
DELETE ${host}/command/playback/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
DELETE https://api.legaoyi.com/command/playback/1.json
{
"channelId":1,
"playbackType":5,
"playTimes":0,
"startTime":"2022-05-30 05:30:00"
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 30 / 70
上传历史视频文件指令接口
平台向车载设备发送上传历史视频文件指令。
请求路径:
POST ${host}/command/uploadFile/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/command/uploadFile/1.json
POST消息体:
指令状态查询接口(兼容JT809)
根据指令id查询指令的下发的状态。
请求路径:
GET ${host}/video/command/{id}/state.json
请求参数:
参数名称
必须
类型
说明
id
是
string
路径参数,指令记录id列表,多个(最多10个)可用“,”分隔
返回参数:
参数名称
必须
类型
说明
id
是
string
指令记录id
state
是
integer
指令状态,
0:终端设备应答成功;
1:终端设备应答失败;
2:终端应答消息有误;
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 31 / 70
3:终端应答消息不支持;
4:消息已下发;
5:终端设备已下线;
6:消息有误;
7:不支持该消息;
8:网关处理中;
9:终端应答超时
请求例子:
GET https://api.legaoyi.com/video/command/1/state.json
开启实时音视频传输指令接口(兼容JT809)
平台向车载设备发送开启实时音视频传输指令。
请求路径:
POST ${host}/video/command/live/{deviceId}.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
dataType
是
int
post消息体参数,数据类型
0:音视频
1:视频
2:对讲
3:监听
streamType
是
int
post消息体参数,码流类型,
0:主码流
1:子码流
返回参数:
参数名称
类型
说明
id
string
指令记录id
streamId
string
视频流id,用作心跳保持
flvUrl
string
http-flv拉流地址
rtmpUrl
string
rtmp拉流地址
hlsUrl
string
https-flv拉流地址(暂不支持)
talkUrl
string
对讲推流wss地址,按照1078协议格式把采集到的pcm(8khz,16位,单通道)数据封装成字节流
请求例子:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 32 / 70
POST https://api.legaoyi.com/video/command/live/5.json
POST消息体:
视频心跳保持接口(兼容JT809)
前端应用开始播放视频(包括历史视频)时,定时(每隔5秒)调用该接口保持心跳,否则后台会自动关闭视频。
请求路径:
PUT ${host}/video/command/heartbeat/{streamId}.json
请求参数:
参数名称
必须
类型
说明
streamId
是
string
路径参数,视频流id
返回参数:
无
请求例子:
PUT https://api.legaoyi.com/video/command/heartbeat/1.json
POST消息体:
停止实时音视频传输控制指令接口(兼容JT809)
平台向车载设备发送停止实时音视频传输控制指令。
请求路径:
{
"channelId":1,
"dataType":0,
"streamType":1
}
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 33 / 70
DELETE ${host}/video/command/live/{streamId}.json
请求参数:
参数名称
必须
类型
说明
streamId
是
string
路径参数,视频流id
返回参数:
无。
请求例子:
DELETE https://api.legaoyi.com/video/command/live/1.json
通过资源id开启录像回放指令接口(兼容JT809)
平台向车载设备发送开启录像回放指令。
请求路径:
POST ${host}/video/command/playback/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
参数名称
类型
说明
id
long
指令记录id
flvUrl
string
http-flv拉流地址
rtmpUrl
string
rtmp拉流地址
hlsUrl
string
http-hls拉流地址(暂不支持)
请求例子:
POST https://api.legaoyi.com/video/command/playback/1.json
POST消息体:
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 34 / 70
停止录像回放指令接口(兼容JT809)
平台向车载设备发送停止录像回放指令。
请求路径:
DELETE ${host}/video/command/playback/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
DELETE https://api.legaoyi.com/video/command/playback/1.json
历史视频资源查询指令接口(兼容JT809)
平台向车载设备发送历史视频资源查询指令。平台会每天定时发送指令查询设备昨天的历史视频资源列表,但不包括今天在内。所以前端应用需要查询今天的历史视频资源时需要先发送改指令获取今天的历史视频资源列表,待车载设备应该成功之后,在调用“查询历史视频资源”接口即可获取历史视频资源列表。对于查询昨天的历史视频资源列表可发可不发送该指令。
请求路径:
POST ${host}/video/command/queryResource/{deviceId}.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号,0代表查询全部通道
streamType
是
int
post消息体参数,码流类型:
0:所有码流
1:主码流
2:子码流
storeType
是
int
post消息体参数,存储器类型:
0:所有存储器
1:主存储器;
2:灾备存储器
resourceType
是
int
文件类型:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 35 / 70
0:音视频
1:音频
2:视颊;
3:音频或视频
startTime
是
string
开始时间,格式:yyyy-MM-dd:hh:mm:ss
endTime
是
string
结束时间,格式:yyyy-MM-dd:hh:mm:ss
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/queryResource/5.json
POST消息体:
上传历史视频文件指令接口(兼容JT809)
平台向车载设备发送上传历史视频文件指令。
请求路径:
POST ${host}/video/command/uploadFile/{resourceId}.json
请求参数:
参数名称
必须
类型
说明
resourceId
是
string
路径参数,历史视频资源记录id
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/uploadFile/1.json
POST消息体:
{
"channelId":0,
"streamType":0,
"storeType":0,
"resourceType":0,
"startTime":"2022-05-30 00:00:00",
"endTime":"2022-05-31 00:00:00"
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 36 / 70
云台控制-云台旋转指令接口
平台向车载设备发送云台旋转指令。
请求路径:
POST ${host}/video/command/{deviceId}/9301.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
direction
是
int
post消息体参数,方向
0:停止
1:上
2:下
3:左
4:右
speed
是
int
post消息体参数,码流类型,范围:0~255
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/5/9301.json
POST消息体:
云台控制-调整焦距控制指令接口
平台向车载设备发送调整焦距控制指令。
{}
{
"channelId":1,
"direction":0,
"speed":1
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 37 / 70
请求路径:
POST ${host}/video/command/{deviceId}/9302.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
direction
是
int
post消息体参数,方向
0:调大焦距
1:调小焦距
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/5/9302.json
POST消息体:
云台控制-调整光圈控制指令接口
平台向车载设备发送调整光圈控制指令。
请求路径:
POST ${host}/video/command/{deviceId}/9303.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
type
是
int
post消息体参数,方向
0:调大
1:调小
返回参数:
返回下行消息对象“DownstreamMessage”详情。
{
"channelId":1,
"direction":0
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 38 / 70
请求例子:
POST https://api.legaoyi.com/video/command/5/9303.json
POST消息体:
云台控制-调整雨刷控制指令接口
平台向车载设备发送调整雨刷控制指令。
请求路径:
POST ${host}/video/command/{deviceId}/9304.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
flag
是
int
post消息体参数,启停控制
0:停止
1:启动
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/5/9304.json
POST消息体:
{
"channelId":1,
"type":0
}
{
"channelId":1,
"flag":0
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 39 / 70
云台控制-红外补光控制指令接口
平台向车载设备发送调整红外补光控制指令。
请求路径:
POST ${host}/video/command/{deviceId}/9305.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
flag
是
int
post消息体参数,启停标识
0:停止
1:启动
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/5/9305.json
POST消息体:
云台控制-变倍控制指令接口
平台向车载设备发送调变倍控制指令。
请求路径:
POST ${host}/video/command/{deviceId}/9306.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
channelId
是
int
post消息体参数,逻辑通道号
type
是
int
post消息体参数,变倍控制
0:调大
1:调小
{
"channelId":1,
"flag":0
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 40 / 70
返回参数:
返回下行消息对象“DownstreamMessage”详情。
请求例子:
POST https://api.legaoyi.com/video/command/5/9306.json
POST消息体:
获取设备最新一条位置信息
返回指定设备最新一条位置信息 。
请求路径:
GET ${host}/gps/device/{deviceId}/last.json.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id
返回参数:
返回位置信息对象“Gps”详情
请求例子:
GET https://api.legaoyi.com/gps/device/1/last.json
获取车辆最新一条位置信息
返回指定车辆绑定的主设备最新一条位置信息。
请求路径:
GET ${host}/gps/car/{carId}/last.json.json
请求参数:
参数名称
必须
类型
说明
carId
是
string
路径参数,车辆id
{
"channelId":1,
"type":0
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 41 / 70
返回参数:
返回位置信息对象“Gps”详情
请求例子:
GET https://api.legaoyi.com/gps/car/1/last.json
获取车辆最新一条位置信息
返回指定车辆绑定的主设备最新一条位置信息。
请求路径:
GET ${host}/gps/vin/{vin}/last.json.json
请求参数:
参数名称
必须
类型
说明
vin
是
string
路径参数,车辆vin码
返回参数:
返回位置信息对象“Gps”详情
请求例子:
GET https://api.legaoyi.com/gps/vin/1/last.json
获取设备位置信息接口
获取指定设备的位置信息。
请求路径:
GET ${host}/device/{deviceId}/location.json
请求参数:
参数名称
必须
类型
说明
deviceId
是
string
路径参数,设备id列表,逗号分隔
返回参数:
返回位置信息对象“Gps”详情。
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 42 / 70
请求例子:
GET https://api.legaoyi.com/device/1,2,3/location.json
获取车辆位置信息接口
获取指定指定车辆的位置信息。
请求路径:
GET ${host}/car/{carId}/location.json
请求参数:
参数名称
必须
类型
说明
carId
是
string
路径参数,车辆id列表,逗号分隔
返回参数:
返回位置信息对象“Gps”详情。
请求例子:
GET https://api.legaoyi.com/car/1,2,3/location.json
获取企业下的设备位置信息接口
获取指定指定车辆的位置信息。
请求路径:
POST ${host}/device/location.json
请求参数:
参数名称
必须
类型
说明
pageNo
否
Integer
路径参数,分页页码
pageSize
否
Integer
路径参数,分页大小
isParent
否
Boolean
路径参数,查询是否包括下级企业
返回参数:
返回位置信息对象“Gps”详情。
请求例子:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 43 / 70
POST https://api.legaoyi.com/device/location.json?pageNo=1&pageSize=1000&isParent=true
POST消息体:
获取企业下的车辆位置信息接口
获取指定指定车辆的位置信息。
请求路径:
POST ${host}/car/location.json
请求参数:
参数名称
必须
类型
说明
pageNo
否
Integer
路径参数,分页页码
pageSize
否
Integer
路径参数,分页大小
isParent
否
Boolean
路径参数,查询是否包括下级企业
返回参数:
返回位置信息对象“Gps”详情。
请求例子:
POST https://api.legaoyi.com/car/location.json?pageNo=1&pageSize=1000&isParent=true
POST消息体:
历史轨迹查询接口
历史轨迹查询不支持跨天查询,如需要查询多天的历史轨迹需要按天分多次查询。
请求路径:
{
}
{}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 44 / 70
POST ${host}/common/query/gps.json
请求参数:
参数名称
必须
类型
说明
pageNo
否
Integer
路径参数,分页页码
pageSize
否
Integer
路径参数,分页大小
orderBy
否
String
路径参数,排序字段
其他路径参数
否
Object
参考元数据接口->查询对象记录
recordDate
是
String
轨迹日期,格式yyyyMMdd
其他POST参数
否
Object
参考元数据接口->查询对象记录
返回参数:
返回位置信息对象“Gps”列表详情。
请求例子:
POST https://api.legaoyi.com/common/query/gps.json?orderBy=time&pageSize=1000&pageNo=1
POST消息体:
区域查车接口
获取指定指定车辆的位置信息。
请求路径:
{
"conditions":{
"enterpriseId.eq":"928280003",
"deviceId.eq":"926050678311223296"
},
"rangeConditions":[
{
"fieldName":"time",
"from":1661158794956,
"includeLower":true,
"includeUpper":true,
"to":1661245202561
}
],
"recordDate":"20220822"
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 45 / 70
POST ${host}/area/car.json
请求参数:
参数名称
必须
类型
说明
type
是
Integer
区域类型:
1:圆形;
2:多边形;
3:省市区
area
是
Object
区域数据
area.radius
是
Integer
type=1时有效,圆形半径
area.lng
是
double
type=1时有效,圆形中心经度,wgs84坐标系
area.lat
是
double
type=1时有效,圆形中心纬度,wgs84坐标系
area.path
是
string
type=2时有效,经纬度列表,逗号分隔
areaCode
是
string
type=3时有效,省市区区域代码
返回参数:
参数名称
类型
说明
lat
double
纬度,wgs84坐标系
lng
double
经度,wgs84坐标系
carId
string
车辆id
请求例子:
POST https://api.legaoyi.com/area/car.json
POST消息体:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 46 / 70
报表通用查询接口
请求路径:
POST ${host}/report/query/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
countable
否
boolean
url参数,是否分页
isParent
否
boolean
url参数,是否统计下级企业,true or false
select
否
String
url参数,返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
//圆形
{
"type":1,
"area":{
"radius":3742234,
"lat":42.11434041811337,
"lng":97.12703872472136
}
}
//多边形,包括矩形
{
"type":2,
"area":{
"path":"74.76828044936637,47.434116381232734;150.357372,47.434914;150.357372
,20.024128;74.768892404381,20.026433029991498"
}
}
//省市区查车
{
"type":3,
"areaCode":"110000"
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 47 / 70
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}”列表详情。
请求例子:
POST https://api.legaoyi.com/report/query/device_alarm.json
POST消息体:
报表求和接口
请求路径:
POST ${host}/report/sum/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
select
是
String
url参数,求和字段
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}” select字段的求和结果。
请求例子:
POST https://api.legaoyi.com/report/sum/enterprise_month_report.json?isParent=true&select=totalCar,legalMileage,drivingTime
{
"conditions":{
"carId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 48 / 70
POST消息体:
报表分组求和接口
请求路径:
POST ${host}/report/listSum/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
select
是
String
url参数,求和字段
group
是
String
统计分组字段
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}” select字段的求和结果。
请求例子:
POST https://api.legaoyi.com/report/listSum/enterprise_month_report.json?select=normalSpeedDrivingTime,lowSpeedDrivingTime,highSpeedDrivingTime,overSpeedDrivingTime&group=month&orderBy=month&desc=false&isParent=true
POST消息体:
{
"conditions":{
"month.eq":202208
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 49 / 70
报表分组求和分页接口
请求路径:
POST ${host}/report/pageSum/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
select
是
String
url参数,求和字段
group
是
String
统计分组字段
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
pageNo
否
Integer
url参数,页数,可为空,默认1
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}” select字段的求和结果。
请求例子:
POST https://api.legaoyi.com/report/pageSum/enterprise_month_report.json?select=normalSpeedDrivingTime,lowSpeedDrivingTime,highSpeedDrivingTime,overSpeedDrivingTime&group=month&orderBy=month&desc=false&isParent=true
POST消息体:
{
"conditions":{
"month.eq":202208
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 50 / 70
报表记录数量统计接口
请求路径:
POST ${host}/report/count/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}”对应的记录条数。
请求例子:
POST https://api.legaoyi.com/report/count/enterprise_month_report.json?isParent=true
POST消息体:
{
"conditions":{
"month.eq":202208
}
}
{
"conditions":{
"month.eq":202208
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 51 / 70
报表记录数量统计接口
请求路径:
POST ${host}/report/distinctCount/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
distinct
是
String
url参数,distinct字段名称
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}”对应的记录条数。
请求例子:
POST https://api.legaoyi.com/report/count/enterprise_month_report.json?isParent=true&distinct=month
POST消息体:
报表记录数量统计接口
请求路径:
POST ${host}/report/sumAndCount/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
{
"conditions":{
"year.eq":2022
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 52 / 70
sum
是
String
url参数,求和字段名称
group
是
String
url参数,分组字段名称
startDate
是
String
开始日期
endDate
是
String
结束日期
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回MongoDB集合对象“{collectionName}”对应的记录条数。
请求例子:
POST https://api.legaoyi.com/ report/sumAndCount/device_day_report.json?sum=legalMileage&group=carId&isParent=true&startDate=2022/08/21&endDate=2022/08/23
POST消息体:
报表分组排序接口
请求路径:
POST ${host}/report/groupMax/{collectionName}
请求参数:
参数名称
必须
类型
说明
collectionName
是
String
路径参数,MongoDB对应的集合名称
isParent
否
boolean
url参数,是否统计下级企业,true or false
max
是
String
url参数,求和字段名称
group
是
String
url参数,分组字段名称
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
{
"conditions":{
" legalmileage.gt":800
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 53 / 70
返回参数:
返回MongoDB集合对象“{collectionName}”对应的记录。
请求例子:
POST https://api.legaoyi.com/ report/groupMax/device_day_report.json?isParent=true&group=carId&max=todayMaxSpeed&pageNo=1&pageSize=10
POST消息体:
车辆日报表查询接口
获取指定车辆日报表信息列表。
请求路径:
GET ${host}/report/car/dayReport/query
请求参数:
参数名称
必须
类型
说明
carId
是
String
车辆id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
返回字段,如需返回所有字段则无需传此参数
{
"conditions":{
},
"rangeConditions":[
{
"fieldName":"date",
"from":20220821,
"includeLower":true,
"includeUpper":true,
"to":20220823
}
]
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 54 / 70
返回参数:
返回车辆日报表对象“CarDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/car/dayReport/query.json? carId=1&startDate=2022/08/24&endDate=2022/08/24&select=a1,a2,a19
车辆日报表求和接口
请求路径:
GET ${host}/report/car/dayReport/sum
请求参数:
参数名称
必须
类型
说明
carId
是
String
车辆id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
求和字段,如需返回所有字段则无需传此参数
返回参数:
返回车辆日报表对象“CarDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/car/dayReport/sum.json? carId=1&select=&startDate=2022/08/24&endDate=2022/08/24
车辆日报表分组求和接口
条件统计车辆日报表信息列表。
请求路径:
POST ${host}/report/car/dayReport/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 55 / 70
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回车辆日报表对象“CarDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/car/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24
POST消息体:
车辆日报表分组求和分页接口
车辆日报表分页统计列表。
请求路径:
GET ${host}/report/car/dayReport/page/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
{
"conditions":{
"carId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 56 / 70
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回车辆日报表对象“CarDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/car/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24&pageSize=10&pageNo=1
POST消息体:
设备日报表查询接口
获取指定设备日报表信息列表。
请求路径:
GET ${host}/report/device/dayReport/query
请求参数:
参数名称
必须
类型
说明
deviceId
是
String
设备id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
返回字段,如需返回所有字段则无需传此参数
返回参数:
返回设备日报表对象“DeviceDayReport”列表详情。
请求例子:
{
"conditions":{
"carId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 57 / 70
GET https://api.legaoyi.com/report/device/dayReport/query.json? deviceId=1&startDate=2022/08/24&endDate=2022/08/24&select=a1,a2,a19
设备日报表求和接口
请求路径:
GET ${host}/report/device/dayReport/sum
请求参数:
参数名称
必须
类型
说明
deviceId
是
String
设备id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
求和字段,如需返回所有字段则无需传此参数
返回参数:
返回设备日报表对象“DeviceDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/device/dayReport/sum.json? deviceId=1&select=&startDate=2022/08/24&endDate=2022/08/24
设备日报表分组求和接口
条件统计设备日报表信息列表。
请求路径:
POST ${host}/report/device/dayReport/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 58 / 70
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回设备日报表对象“DeviceDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/device/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24
POST消息体:
设备日报表分组求和分页接口
设备日报表分页统计列表。
请求路径:
GET ${host}/report/device/dayReport/page/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
分组统计字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
{
"conditions":{
"deviceId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 59 / 70
返回参数:
返回设备日报表对象“DeviceDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/device/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24&pageSize=10&pageNo=1
POST消息体:
司机日报表查询接口
获取指定司机日报表信息列表。
请求路径:
GET ${host}/report/driver/dayReport/query
请求参数:
参数名称
必须
类型
说明
driverId
是
String
司机id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
返回字段,如需返回所有字段则无需传此参数
返回参数:
返回司机日报表对象“DriverDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/driver/dayReport/query.json? driverId=1&startDate=2022/08/24&endDate=2022/08/24&select=a1,a2,a19
{
"conditions":{
"deviceId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 60 / 70
司机日报表求和接口
请求路径:
GET ${host}/report/driver/dayReport/sum
请求参数:
参数名称
必须
类型
说明
driverId
是
String
司机id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
求和字段,如需返回所有字段则无需传此参数
返回参数:
返回司机日报表对象“DriverDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/driver/dayReport/sum.json? driverId=1&select=&startDate=2022/08/24&endDate=2022/08/24
司机日报表分组求和接口
条件统计司机日报表信息列表。
请求路径:
POST ${host}/report/driver/dayReport/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 61 / 70
返回参数:
返回司机日报表对象“DriverDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/driver/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24
POST消息体:
司机日报表分组求和分页接口
司机日报表分页统计列表。
请求路径:
GET ${host}/report/driver/dayReport/page/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
返回字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
pageSize
否
Integer
url参数,分页大小,可为空,默认20条
pageNo
否
Integer
url参数,页数,可为空,默认1
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回司机日报表对象“DriverDayReport”列表详情。
请求例子:
{
"conditions":{
"carId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 62 / 70
POST https://api.legaoyi.com/report/driver/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24&pageSize=10&pageNo=1
POST消息体:
获取司机今日统计信息接口
获取司机今日统计信息。
请求路径:
GET ${host}/report/driver/dayReport/today/{driverId}
请求参数:
参数名称
必须
类型
说明
driverId
是
String
路径参数,司机id
返回参数:
返回司机日报表对象“DriverDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/driver/dayReport/today/1.json
获取司机统计缓存信息接口
获取司机统计缓存信息。
请求路径:
GET ${host}/report/driver/statCache/{driverId}
请求参数:
参数名称
必须
类型
说明
driverId
是
String
路径参数,司机id
{
"conditions":{
"driverId.eq":1
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 63 / 70
返回参数:
返回司机日报表对象“DriverDayReport”列表详情
请求例子:
GET https://api.legaoyi.com/report/driver/statCache/1.json
企业日报表查询接口
获取指定企业日报表信息列表。
请求路径:
GET ${host}/report/enterprise/dayReport/query
请求参数:
参数名称
必须
类型
说明
enterpriseId
是
String
企业id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
返回字段,如需返回所有字段则无需传此参数
返回参数:
返回企业日报表对象“EnterpriseDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/enterprise/dayReport/query.json? enterpriseId=1&startDate=2022/08/24&endDate=2022/08/24&select=a1,a2,a19
企业日报表求和接口
统计指定日期范围内的企业日报表。
请求路径:
GET ${host}/report/enterprise/dayReport/sum
请求参数:
参数名称
必须
类型
说明
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 64 / 70
enterpriseId
是
String
企业id
startDate
是
String
开始日期
endDate
是
String
结束日期
select
否
String
求和字段,如需返回所有字段则无需传此参数
返回参数:
返回企业日报表对象“EnterpriseDayReport”列表详情。
请求例子:
GET https://api.legaoyi.com/report/enterprise/dayReport/sum.json? enterpriseId=1&select=&startDate=2022/08/24&endDate=2022/08/24
企业日报表分组求和接口
条件统计企业日报表信息列表。
请求路径:
POST ${host}/report/enterprise/dayReport/sum
请求参数:
参数名称
必须
类型
说明
group
是
String
统计分组字段
startDate
是
String
开始日期
endDate
是
String
结束日期
isParent
否
boolean
是否统计下级企业,true or false
select
否
String
求和字段,如需返回所有字段则无需传此参数
orderBy
否
String
url参数,排序字段(对应实体对象字段名称)
desc
否
Boolean
url参数,是否降序(可选值:ture、 false)
form
否
Object
post消息体参数(json格式),查询条件对象,支持and查询,key-value值,支持gt,gte,lt,lte,eq,neq,like操作
返回参数:
返回企业日报表对象“EnterpriseDayReport”列表详情。
请求例子:
POST https://api.legaoyi.com/report/enterprise/dayReport/sum.json? startDate=2022/08/24&endDate=2022/08/24
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 65 / 70
POST消息体:
调试方法
平台的接口可使用restclient测试工具进行测试,restclient小工具可以使用火狐firefox插件,请用火狐浏览器到
https://addons.mozilla.org/zh-CN/firefox/addon/restclient/
页面进行安装。使用方法
如下,以下以查询设备基础信息为例子:
步骤一
在火狐浏览器中打开restclient插件,如下:
步骤二
参考上一章节的接口文档,在插件中输入请求方法(POST)、请求url(http://api.legaoyi.com/common/query/device.json)以及请求消息体(查找在线设备:{"state.eq":3}),如下图:
{
"conditions":{
"year.eq":2022
}
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 66 / 70
步骤三
添加HTTP头字段,如下图:
步骤四
增加HTTP头字段,选择“自定义HTTP头字段”,如下图:
步骤五
在弹出的对话框中,输入“Content-Type”以及
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 67 / 70
“application/json;charset=UTF-8”,如下图:
步骤六
点击“发送”按钮,如下图:
查询结果如下:
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 68 / 70
其他例子
获取设备最新一条位置信息
请求方法:GET
消息体:空
返回结果:
{
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 69 / 70
"code": 0,
"message": "success",
"data": {
"alarmFlag": "00000000000000000000000000000000",
"statusFlag": "11001000000000000000000000000000",
"lng": "108.721721",
"lat": "34.472976",
"altitude": 500,
"speed": 63.0,
"direction": 153,
"gpsTime": 1531443746000,
"mileage": 6530.0,
"oilmass": 19.9,
"dvrSpeed": 71.5,
"alarmEventId": 0,
"networkSignalNum": 0,
"gpsSatelliteNum": 0,
"_id": "8723008037d04040a38efde64f5092a1"
}
}
历史轨迹查询
请求方法:POST
请求URL:
http://api.legaoyi.com/common/query/gps.json?select=lng,lat&orderBy=time&pageSize=500&pageNo=1
消息体:
{
"recordDate":"20180713",
"conditions":{
"deviceId.eq":"2c9299d4612266f2016122c1a0340010"
},
"rangeConditions":[
{
"fieldName":"gpsTime",
"from":1531432800000,
"includeLower":true,
"includeUpper":true,
"to":1531454399000
}
]
}
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 70 / 70
返回结果:
{
"code": 0,
"message": "success",
"data": [{
"_id": "c4a5fc6891fb46e2b9d47e9a40623a24",
"lng": "108.78053",
"lat": "34.459673"
}, {
"_id": "05edaca30ee04d2db591b68ba19372d0",
"lng": "108.780543",
"lat": "34.459658"
}, {
"_id": "1ab93d46f8f04365bbf76b7c489c24e1",
"lng": "108.780538",
"lat": "34.459633"
}, {
"_id": "a2a7094692dc4149800ab2ef535628b0",
"lng": "108.780533",
"lat": "34.459648"
}, {
"_id": "d3f61cb1724c4386a35967a5c4f55fa6",
"lng": "108.780535",
"lat": "34.459633"
}]
}