一.登录 GET
/api/v1/login参数
| 字段 | 类型 | 描述 |
|---|---|---|
| username | String | 用户名 |
| password | String | 密码(经过md5加密,32位长度,不带中划线,不区分大小写) |
200
| 字段 | 类型 | 描述 |
|---|---|---|
| Token | String | 开启鉴权后访问接口需要带上Token信息 |
| TokenTimeout | Number | Token 超时(秒) |
| EasyDarwin | Object | |
| Header | Object | |
| CSeq | String | 交互序列号 |
| Version | String | 接口版本 |
| MessageType | String | 消息类型 |
| ErrorNum | String | 错误码 |
| ErrorString | String | 错误信息 |
| Body | Object |
首先调用登录接口得到token值,格式如下：
http://公网IP:18000/api/v1/login?username=登录easycvr的账号&password=登录easycvr的经过MD5加密的32位密码
例如:http://112.1.79.2:18000/api/v1/login?username=easycvr&password=D0E73E4206024C86717B1E0D267C4DFD
二.设备列表 GET
在正式调用实现功能的接口时需要先调用登录的接口得到token值，随后我们要调的每一个接口都要携带这个token值。
/api/v1/devicesconfig参数
| 字段 | 类型 | 描述 |
|---|---|---|
| start | Number | 分页开始,从零开始 |
| limit | Number | 分页大小 |
| device可选 | Number | 设备ID |
| protocol_type可选 | String | 设备类型(备注:海康:sdk;NET_PULL:ipc;RTMP_PUSH:rtmp_push;) 允许值: |
| q可选 | String | 查询参数 |
200
| 字段 | 类型 | 描述 |
|---|---|---|
| DeviceCount | Number | 设备总数 |
| Devices | Array | 设备列表 |
| EasyDarwin | Object | |
| Header | Object | |
| CSeq | String | 交互序列号 |
| Version | String | 接口版本 |
| MessageType | String | 消息类型 |
| ErrorNum | String | 错误码 |
| ErrorString | String | 错误信息 |
| Body | Object | |
| DeviceID | Number | 设备ID |
| DeviceName | String | 设备名称 |
| DevicePort | Number | 端口 |
| DeviceIp | String | 设备ip地址 |
| DeviceType | String | 设备类型 |
| Manufacturer | String | 设备厂商 |
| Enable | Number | 是否启用 允许值: |
| Transport | Number | 传输协议 允许值: |
| Online | Number | 在线状态 允许值: |
| OriginalID | String | Ehome设备原始id E86162103 |
调用格式：
http://公网IP：18000/api/v1/devicesconfig?start=从哪一页开始&limit=每页要展示的条数&token=调用上方登录接口得到的token值
例如：
三. 告警通知列表 GET
在正式调用实现功能的接口时需要先调用登录的接口得到token值，随后我们要调的每一个接口都要携带这个token值。
/api/v1/alarmlist参数
| 字段 | 类型 | 描述 |
|---|---|---|
| pageindex | String | 当前页-1 |
| pagesize | String | 页面容量 |
| q | String | 设备id通道id搜索 |
| priority | String | 报警级别 |
| method | String | 报警方式 |
| starttime | String | 开始时间过滤(YYYY-MM-DD HH:mm:ss) |
| endtime | String | 结束时间过滤(YYYY-MM-DD HH:mm:ss) |
200
| 字段 | 类型 | 描述 |
|---|---|---|
| alarmCount | Number | 数据数量 |
| alarmList | Array | 分组列表 |
| ID | String | 报警序列号 |
| DeviceID | String | 设备id |
| ChannelID | String | 通道id |
| DeviceName | String | 设备名称 |
| ChannelName | String | 通道名称 |
| AlarmPriority | String | 报警级别 |
| AlarmTime | String | 时间 |
| AlarmMethod | String | 报警方式 |
| AlarmType | String | 报警类型 |
| AlarmSnap | String | 快照地址 |
| pageindex | 当前页-1 | |
| pagesize | 页面容量 |
格式如下：
在调用告警接口的时候需要一个_t的值，在调用下面的接口时，需要先进行这步操作得到_t的值，
http://公网IP:18000/api/v1/alarmlist?_t=你的_t值&pageindex=0&pagesize=页面容量&priority=0&method=0
例如
http://112.1.79.2:18000/api/v1/alarmlist?_t=1721698128&pageindex=0&pagesize=10&priority=0&method=0
四.获取设备通道直播链接 GET
/api/v1/devices/channelstream参数
| 字段 | 类型 | 描述 |
|---|---|---|
| device | Number | 设备id (备注:通道列表中ParentDeviceID字段获取 ) |
| channel | Number | 通道id (备注:通道列表中ChannelID字段获取 ) |
| protocol | String | 直播协议 允许值: |
| Token可选 | String | 播放token |
| type可选 | String | 首次播放之后保活请带上此字段 允许值: |
200
| 字段 | 类型 | 描述 |
|---|---|---|
| URL | String | 直播链接 |
| ChannelName | String | 通道名称 |
| DeviceType | String | 接入协议 |
| DeviceID | Number | 设备ID |
| ChannelID | Number | 通道ID |
| SnapURL | String | 快照地址 |
| EasyDarwin | Object | |
| Header | Object | |
| CSeq | String | 交互序列号 |
| Version | String | 接口版本 |
| MessageType | String | 消息类型 |
| ErrorNum | String | 错误码 |
| ErrorString | String | 错误信息 |
| Body | Object |
格式如下：
http://公网IP:18000/api/v1/devices/channelstream?device=设备id&channel=通道id&protocol=直播协议&token=登录的时候获取到的token值
此时我们得到了视频流，需要把这个视频流和我们的公网IP和端口号组合
http://112.1.79.202:18000/flv/live/34020000001320000001_34020000001310000001_0200000001.flv
五.指定时间段云端录像播放及下载 GET
/api/v1/record/recordvideo/:operate/:file/:id/:starttime/:endtime参数
| 字段 | 类型 | 描述 |
|---|---|---|
| operate | String | 调用操作 play:播放 download下载 允许值: |
| file | String | 文件类别 m3u8:(只提供在线地址) mp4:支持 允许值: |
| id | String | 通道id (备注:通道列表中ChannelID字段获取 ) |
| starttime | String | 开始时间, YYYYMMDDHHmmss |
| endtime | String | 结束时间, YYYYMMDDHHmmss |
格式如下：
http://公网IP:18000/api/v1/record/recordvideo/play/m3u8/1/你想要得到的回放视频的开始时间20240724103010/你想要得到的回放视频的结束时间20240724103050
例如：http://112.1.79.202:18000/api/v1/record/recordvideo/play/m3u8/1/20240724103010/20240724103050
把得到的视频流和http://112.1.79.202:18000进行拼接，然后复制到VLC播放器，进行回放的播放
http://112.1.79.202:18000/hls/34020000001320000001_34020000001310000001_0200000001/34020000001320000001_34020000001310000001_0200000001_20240724103010_20240724103050.m3u8
