专用于出租屋门禁场景,视频联动抓拍,可抓拍图片、小视频,实有人口/实有房屋、门禁出入记录可上传市局、省公安厅平台。
云果视频控制器接口与平台说明
- 概述
视频控制器与平台交互采用HTTP协议,视频控制器采用主动轮循的方式,平台需在相应URL提供服务来处理相应的请求。
交互流程如下:
配置软件 |
视频控制器 |
平台 |
提供平台服务地址 |
配置平台地址、摄像头、门禁序列号 |
配置摄像头密码并搜索设备 |
接入网络并上电 |
保存平台地址并获取各服务URL |
获取服务URL |
返回服务URL |
上报设备心跳 |
周期性上报心跳 |
返回控制指令 |
有控制指令则返回,否则返回空指令 |
门禁刷卡动作 |
调用摄像头抓拍 |
上传抓拍 |
返回抓拍存储结果 |
删除抓拍缓存 |
- 配置获取接口
接口功能:用于配置视频控制器(H3,下方简称H3)与平台交互的URL地址
请求方式:GET
数据格式:json
接口地址:例如http://XXXX/api/config |
说明 |
|
请求头 |
User-Agent :CloudGO H3:设备版本号 |
(H3->SRV) |
acsn:门禁序列号 |
|
|
返回报文: |
|
|
|
DeviceStatus,类型string;控制器状态上报地址 ImageUrl,类型string;图像上传地址 VideoUrl,类型string;视频文件上传地址 Videodoor,类型string;视频平台地址 update,类型string;程序跟新控制地址 SwipeRecord,类型string;刷卡记录上传地址
例如: { "DeviceStatus":"http://172.239.209.132:8081/lockinfo/DeviceControl", "ImageUrl":"http://172.239.209.132:8082/UploadCapture/", "VideoUrl":"http://172.239.209.132:8082/UploadMJVideo/", "update":"http://172.239.209.132:8081/Client1/AppUpdate", "Videodoor":"http://172.239.209.132:8081/Video/videoStatus", "SwipeRecord":http://172.239.209.132:8081/lockinfo/SubmitRecord" }
|
(SRV-> H3)
|
- 设备心跳接口
接口功能:用于视频控制器向平台提交心跳
请求方式: POST
数据格式:json
接口地址:http://XXXX/api/video/videostatus |
说明 |
||
请求头 |
User-Agent :CloudGO H3:设备版本号 |
(H3->SRV) |
|
acsn:门禁序列号 |
|
||
请求报文: param={下以的JSON格式} |
|
||
VideoStartTime,整形类型;录像文件最早时间; VideoEndTime,整形类型;录像文件最后时间; ChannelState,整形类型;各通道状态数据,已过时 SerialNo,字符串类型;门禁控制器序列号 ctrltype,整形类型;门禁控制器类型 ChannelCount,整形类型;视频通道数量 RequestType,整形类型;设备控制指令码 RequestData,JSON类型;请求数据null Version,字符串类型;固件版本号 diskstorage,字符串类型;磁盘使用信息 FlashStorage,字符串类型;FLASH使用率 ChanelStateNew, 字符串类型;各通道状态数据, 其中:视频通道状态信息结构如下: IP,字符串类型;摄像头IP地址 Band,字符串类型;摄像头品牌 Model,字符串类型;摄像头型号 |
(H3->SRV) |
||
RetCode; 整形类型;填1 CtrlType;整形类型;当前控制指令,不需要其他控制,填0 Channel; 整形类型;通道ID, 0xFF为所有通道 StartTime; 字符串类型;文件播放起始时间,填null EndTime;字符串类型;文件播放结束时间,填null CtrlData; 数组类型;用于存放stmp通道地址,填null curtime; 整形类型;平台当前Unix时间戳,用于同步设备时间 Bitx整形类型; 视频播放倍数,填null
|
(SRV ->H3) |
||
举例:心跳请求 param={ "RequestType":1, "SerialNo":"1101481201", //门禁控制器序列号 "ChannelCount":2, "Version":"1.3.3.1", "ctrltype":2, //1:表示云果门禁控制器,2:表示微耕控制器 "diskstorage":"950.20GB|100.00GB", "FlashStorage":"7.20GB|1.00GB", "VideoStartTime":1555747300, //最早录像视频时间 "VideoEndTime":1558339300, //最近录像视频时间 "RequestData":"", "ChanelStateNew":[ { "IP":"192.168.1.202", "status":1, //表示摄像头连接 "Band":"Dahua", "Model":"IPC-HFW2125M-AS-I1", }, { "IP":"192.168.1.203", "status":1, "Band":"Dahua", "Model":"IPC-HFW2125M-AS-I1", }, ] } 平台返回数据 { "RetCode":1, "CtrlType":0, "Channel":0, "StartTime":null, "EndTime":null, "CtrlData":null, "curtime":1558339300, "Bitx":null } |
|
||
- 图片上传接口
接口功能:上传图片
请求方式: POST
数据格式:文件流(MultipartBody)
接口地址:例如http://XXXX/api/UploadCapture |
说明 |
|
请求头 |
User-Agent :CloudGO H3:设备版本号 |
(H3->SRV) |
acsn:门禁序列号 Content-Disposition: form-data; filename=” 1101481201-1623497189-20190517122818-01_01.jpg” 文件名说明:1101481201:门禁序列号 1623497189:当前刷卡卡号 20190517122818:当前刷卡时间 01_01: 针对当前刷卡的第几个摄像头的第几张抓拍(一次刷卡可以支持多个摄像头同时抓拍多张) 内容:文件流 |
|
|
返回报文: |
|
|
|
ret=0/1; 0:表示存储成功,控制器将删除抓拍图片缓存, 1:表示存储失败,控制器将重新提交抓拍 |
(SRV-> H3)
|