乐高易软件-乐高易车联网平台接口体系 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)。返回结果数据结构如下：
返回参数说明：
返回json示例：
元数据接口属于框架层面的通用接口，提供了基于实体的CURD操作，为标准的RESTful风格接口。
请求路径：
GET ${host}/system/objects
请求参数：
无
返回参数：
{ "code":0, "message":"success", "data":{ }} 乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 6 / 70
请求例子：
GET https://api.legaoyi.com/system/objects.json
请求路径：
GET ${host}/system/object/{entityName}/description
请求参数：
返回参数：
对象描述信息
请求例子：
GET https://api.legaoyi.com/system/object/device/description.json
请求路径：
GET ${host}/system/message/{messageId}/description
请求参数：
返回参数：
消息描述信息
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 7 / 70
请求例子：
GET https://api.legaoyi.com/system/message/0200/description.json
请求路径：
GET ${host}/system/message/{messageId}/example
请求参数：
返回参数：
消息样例信息
请求例子：
GET https://api.legaoyi.com/system/message/0200/example.json
对象记录列表查询接口，根据给定的实体名称和查询条件查询对象数据。根据对象数据的存储所用的数据库（mysql、mongodb），查询条件稍有不同，具体参考以下介绍。
请求路径：
POST ${host} /common/query/{entityName}.json
请求参数：
url参数，返回字段信息（对应实体对象字段名称），逗号分隔
url参数，是否需要返回分页参数（可选值：ture、 false）
url参数，是否降序（可选值：ture、 false）
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 8 / 70
post消息体参数(json格式)，查询条件对象，支持and查询，key-value值，支持gt，gte，lt，lte，eq，neq，like操作
对于关系型数据库（mysql）
form参数格式：
对于mongodb数据库：
form参数格式：
数据存放时间yyyyMMdd格式（由于mongodb中部分数据是按天分表存放，这部分数据需要传此参数）
普通查询条件，支持and查询，key-value值，支持gt，gte，lt，lte，eq操作
conditions参数格式：
rangeConditions参数格式：
返回结果：
返回对象记录列表，如果没有匹配的结果，则返回一个空的数组。
乐高易软件-乐高易车联网平台接口体系 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
返回参数：
对象记录详情，如果没有匹配的结果，则返回空。
请求例子：
GET https://api.legaoyi.com/common/user/1.json
新增对象记录详情。
请求路径：
POST ${host}/common/{entityName}.json
请求参数：
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
请求参数：
post消息体参数(json格式)，实体对象记录详情，key-value值
返回参数：
修改成功后的记录详情。
请求例子：
PATCH https://api.legaoyi.com/common/user/1.json
POST消息体：
删除对象记录。
请求路径：
DELETE ${host}/common/{entityName}/{ids}.json
请求参数：
返回参数：
{ "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定制化接口，实现特定的逻辑。一般情况下，为了减少业务接口，如果通用接口可以实现的数据操作，则应不提供或者尽量少提供定制化的业务接口。
请求路径：
GET ${host}/ oauth2/token.json
请求参数：
路径参数，
grant_type=password时为用户名称；
grant_type=phone时为手机号码
路径参数，
grant_type=password时为经过AES加密后的用户密码；
grant_type=phone时为手机验证码
返回参数：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 13 / 70
请求例子： GET https://api.legaoyi.com/ /oauth2/token.json?grant_type=password&username=test&password=ecM4pCU0VV0xnlhACrb1Tg
请求路径：
GET ${host}/ oauth2/token.json
请求参数：
返回参数：
请求例子：
GET https://api.legaoyi.com/ /oauth2/token.json?grant_type=refresh_token& refresh_token=ecM4pCU0VV0xnlhACrb1Tg
请求路径：
GET ${host}/aas/authentication.json
请求参数：
无
返回参数：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 14 / 70
请求例子：
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
请求参数：
返回参数：
设备状态,
0:未注册；
1:已注册；
2:离线；
3:在线;
4:已注销；
5：已停用
请求例子：
GET https://api.legaoyi.com/device/1,2,3/state.json
请求路径：
GET ${host}/device/{id}/bizState.json
请求参数：
返回参数：
业务状态：
0：离线；
1：行驶；
2：停车；
3：熄火；
4：无信号
请求例子：
GET https://api.legaoyi.com/device/1,2,3/bizState.json
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 16 / 70
获取设备信息接口请求路径：
GET ${host}/device/{id}.json
请求参数：
返回参数：
返回设备对象“Device”详情
请求例子：
GET https://api.legaoyi.com/device/1.json
请求路径：
GET ${host}/device/{id}/car.json
请求参数：
返回参数：
返回“DeviceCar”对象详情。
请求例子：
GET https://api.legaoyi.com/device/1/car.json
请求路径：
GET ${host}/device/{id}/terminal/params.json
请求参数：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 17 / 70
返回参数：
请求例子：
GET https://api.legaoyi.com/device/1/terminal/params.json
请求路径：
GET ${host}/car/{id}/state.json
请求参数：
返回参数：
设备状态,
0:未注册；
1:已注册；
2:离线；
3:在线;
4:已注销；
5：已停用
请求例子：
GET https://api.legaoyi.com/car/1/state.json
请求路径：
GET ${host}/car/{id}/bizState.json
请求参数：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 18 / 70
返回参数：
业务状态：
0：离线；
1：行驶；
2：停车；
3：熄火；
4：无信号
请求例子：
GET https://api.legaoyi.com/device/1,2,3/bizState.json
请求路径：
DELETE ${host}/car/device/{deviceId}.json
请求参数：
返回参数：
无
请求例子：
DELETE https://api.legaoyi.com/car/device/1.json
请求路径：
GET ${host}/device/driver/{deviceId}.json
请求参数：
返回参数：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 19 / 70
返回司机对象“Driver”详情。请求例子：
GET https://api.legaoyi.com/device/driver/1.json
请求路径：
GET ${host}/car/driver/{carId}.json
请求参数：
返回参数：
返回司机对象“Driver”详情。
请求例子：
GET https://api.legaoyi.com/car/driver/1.json
请求路径：
POST ${host}/driver/car/unbind.json
请求参数：
无
返回参数：
请求例子：
GET https://api.legaoyi.com/driver/car/unbind.json
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 20 / 70
指令下发接口平台向车载设备发送指令。
请求路径：
POST ${host}/command/{deviceId}/{messageId}.json
请求参数：
路径参数，消息ID（参考乐高易网关使用手册中对应消息id的定义）
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
路径参数，消息ID（参考乐高易网关使用手册中对应消息id的定义）
post消息体参数(json格式)，
协议网关定义消息体（参考乐高易网关使用手册中对应消息体的定义），key-value值
ost消息体参数，设备id列表，多个设备id之间“,”逗号分隔
返回参数：
返回下行消息对象“DownstreamMessage”详情。
请求例子：
POST https://api.legaoyi.com/batch/command/9101.json
POST消息体：
根据指令id查询指令的下发的状态。
请求路径：
GET ${host}/command/{id}/state.json
请求参数：
路径参数，指令记录id列表，多个（最多10个）可用“，”分隔
返回参数：
指令状态，
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
请求参数：
post消息体参数，数据类型
0:音视频
1:视频
2:对讲
3:监听
post消息体参数，码流类型，
0：主码流
1：子码流
返回参数：
对讲推流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
请求参数：
返回参数：
无
请求例子：
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
请求参数：
post消息体参数，控制指令
0:关闭音视频
1:切换码流
2:暂停播放
3:恢复播放
4:关闭对讲
post消息体参数，关闭音视频类型
0:关闭全部
1:关闭音频，保留视频
2:关闭视频，保留音频
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
请求参数：
post消息体参数，逻辑通道号，0代表查询全部通道
post消息体参数，码流类型:
0:所有码流
1：主码流
2：子码流
post消息体参数，存储器类型:
0：所有存储器
1:主存储器；
2：灾备存储器
文件类型：
0:音视频
1:音频
2:视颊；
3:音频或视频
开始时间，格式：yyyy-MM-dd:hh:mm:ss
结束时间，格式：yyyy-MM-dd:hh:mm:ss
返回参数：
返回下行消息对象“DownstreamMessage”详情。
请求例子：
POST https://api.legaoyi.com/command/5/9205.json
POST消息体：
请求路径：
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
返回参数：
是否存在视频资源，true 存在；false：不存在
请求例子：
GET https://api.legaoyi.com/video/hisVideoResource/5/check/last30days.json? channelId=1
平台向车载设备发送开启录像回放指令。
请求路径：
POST ${host}/command/playback/{resourceId}.json
请求参数：
返回参数：
请求例子：
POST https://api.legaoyi.com/command/playback/1.json
POST消息体：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 27 / 70
开启录像回放指令接口平台向车载设备发送开启录像回放指令。
请求路径：
POST ${host}/command/{deviceId}/9201.json
请求参数：
post消息体参数，回放方式
0:正常回放;
1:快进回放;
2:关键帧快退回放;
3:关键帧播放;
4:单帧上传;
post消息体参数，快进或快退倍数
回放控制为1和2时,此字段内容有效,否则置0。
0;无效;
1 :1倍;
2:2倍;
3:4倍;
4:8倍;
5:16倍
post消息体参数，开始回放位置
格式：yyyy-MM-dd:hh:mm:ss,
回放控制为4时,表示单帧上传时间
post消息体参数，结束回放位置
格式：yyyy-MM-dd:hh:mm:ss,
返回参数：
请求例子：
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
请求参数：
post消息体参数，回放方式
0:开始回放;
1 :暂停回放;
2:结束回放;
3:快进回放;
4:关键帧快退回放;
5:拖动回放;
6:关键帧播放
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
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
请求参数：
返回参数：
返回下行消息对象“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
请求参数：
返回参数：
返回下行消息对象“DownstreamMessage”详情。
请求例子：
POST https://api.legaoyi.com/command/uploadFile/1.json
POST消息体：
根据指令id查询指令的下发的状态。
请求路径：
GET ${host}/video/command/{id}/state.json
请求参数：
路径参数，指令记录id列表，多个（最多10个）可用“，”分隔
返回参数：
指令状态，
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
平台向车载设备发送开启实时音视频传输指令。
请求路径：
POST ${host}/video/command/live/{deviceId}.json
请求参数：
post消息体参数，数据类型
0:音视频
1:视频
2:对讲
3:监听
post消息体参数，码流类型，
0：主码流
1：子码流
返回参数：
对讲推流wss地址，按照1078协议格式把采集到的pcm（8khz,16位，单通道）数据封装成字节流
请求例子：
乐高易软件-乐高易车联网平台接口体系 www.legaoyi.com
广西乐高易网络有限公司 www.legaoyi.com 32 / 70
POST https://api.legaoyi.com/video/command/live/5.json
POST消息体：
前端应用开始播放视频(包括历史视频)时，定时（每隔5秒）调用该接口保持心跳，否则后台会自动关闭视频。
请求路径：
PUT ${host}/video/command/heartbeat/{streamId}.json
请求参数：