海康云眸 IoT API
复制页面
海康云眸 IoT API
产品介绍
能力概览
错误码表
报警类型表
常见问题
示例DEMO
快速入门
接口调用说明
生成授权凭证
POST
基础服务能力
设备分组管理
新增组
删除组
更新组
获得单个组详情
查询所有节点列表
查找组的下级节点
设备管理
注册设备
注销设备
修改设备名称
获得单个设备信息
获得设备列表
获取设备总数
查询设备状态
设备确权
确权流程说明
下线确认
上线确认
通道管理
查询设备下通道列表
同步设备下通道
修改通道名称
人员管理
添加人员
更新人员信息
删除人员信息
获得单个人员详情
人脸评分标准配置接口
人员人脸更新
人员人脸删除
报警能力管理
获取报警能力列表
GET
修改报警能力状态
POST
视频服务能力
视频对接指南
视频参数配置
视频设备码流参数配置指南
接口配置
获取音视频单通道编码能力
获取音视频单通道编码配置
设置音视频单通道编码配置
视频集成方案
web视频控件
UIKIT
微信小程序
移动端SDK
Android
IOS
错误码对照表
标准流预览
开通标准流预览功能
获取标准流预览地址
获取预览/回放地址
互动直播间
创建直播间
编辑直播间
删除直播间
查询直播间列表
设置直播间状态
账号充值
设备视频加密
关闭设备视频加密
开启设备视频加密
云台控制
开始云台控制
停止云台控制
3D放大
预置点操作
添加预置点
更新预置点
清除预置点
调用预置点
加载预置点
取流认证
GET
远程抓图
POST
门禁服务能力
门禁对接指南
卡片操作
新增卡片
删除卡片
根据人员编号删除卡片
门禁计划
计划模板管理
周计划模板添加/更新
周计划模板获取
周计划模板删除
假日计划模板添加/更新
假日计划模板获取
假日计划模板删除
门禁计划管理
周计划配置
周计划获取
假日计划配置
假日计划获取
假日组计划配置
假日组计划获取
门禁计划配置
门禁计划聚合配置
门禁计划获取
清空门禁计划
权限分组
权限组新增
权限组更新
权限组删除
获取权限组列表
权限组绑定人员
权限组解绑人员
权限组获取人员编号列表
权限组绑定设备
权限组解绑设备
权限组获取设备序列号列表
人员权限信息查询
权限下发
根据权限组下发权限
查询下发失败记录
下发所有失败人员
清空设备本地权限
获取设备能力集
人员权限信息更新
远程控门
远程控门
远程呼梯
可视对讲
设置可视对讲通知地址
可视对讲交互事件通知
获取可视对讲通知地址
人员信息采集
远程采集方式
规则配置
获取规则配置
采集身份证信息
采集卡信息
采集指纹信息
采集人脸信息
获取人脸采集进度
本地采集方式
规则配置
获取规则配置
录入人员信息
查询采集数据
获取采集状态信息
删除全部采集数据
根据人员编号删除采集数据
多重认证
获取群组配置
群组配置
清除群组配置
获取多重认证配置
设置多重认证配置
访客二维码生成
POST
设备本地事件查询
GET
边缘人脸服务能力
边缘人脸对接指南
人脸库管理
创建人脸库
删除全部人脸库
删除单个人脸库
获取所有人脸库基本参数
批量设置人脸 库基本参数
获取单个人脸库基本参数
设置单个人脸库基本参数
查询人脸库剩余人脸数及磁盘容量
人脸库人脸管理
查询单个人脸库中人脸信息
删除单个人脸库中人脸
人脸下发入库
人脸批量异步下发
查询人脸异步下发任务状态
查询人脸异步下发所有任务状态
人脸下发底图入库状态查询
人脸异步下发任务删除
设置人脸比对参数配置
设置人脸比对参数配置
获取人脸比对参数配置
设置人脸比对/陌生人比对联动配置
客流统计
客流统计参数配置
客流统计参数配置获取
查询客流数据
消息通道
对接指南
消息类型定义
消息通道API
创建消费者
消费消息
提交偏移量
其他设备能力
萤石探测器
获取探测器列表
关联探测器
设置探测器状态
删除探测器
获取可关联的IPC列表
获取已关联的IPC列表
设置探测器与IPC的关联关系
修改探测器名称
一键消警
区域热度
获取区域关注度配置
区域关注度配置
生成热度图
获取热度图
获取热度图配置
设置热度图配置
设备校时
获取设备校时配置
配置设备校时
获取NTP服务器配置
配置NTP服务器
获取指定NTP服务器配置
配置指定NTP服务器参数
萤石云储存
设备开通云存储
开启/关闭云存储
获取设备云存储信息
视频安全帽
设备本地开关权限控制
设备录像开关
设备立即上报按键触发抓图事件
设备立即上报状态信息
设备补光灯开关
设备激光灯开关
报警主机
获取子系统列表
获取防区列表
获取主机状态
获取所有防区状态
子系统布防
子系统撤防
设备布撤防
历史接口
组管理
新增组
修改组
删除组
获取所有组
查找组的下级节点
组管理V2
新增组
修改组
删除组
获取所有组
获取单个组信息
查找组的下级节点
设备管理
注册设备
注销设备
获取设备列表
获取单个设备信息
修改设备名称
获取设备总数
设备布撤防
通道管理
查询设备下通道列表
同步设备下通道
修改通道名称
设备抓图
标准流预览
关闭设备视频加密
开通标准流预览功能
获取标准流预览地址
获取指定有效期标准流预览地址
云台操作
开始云台控制
停止云台控制
添加预置点
调用预置点
清除预置点
门禁管理
门禁管理
人员下发
人员更新
人员查询
人员删除
卡下发
卡更新
卡查询
卡删除
人脸下发
人脸修改
人脸查询
人脸删除
访客二维码生成
远程控门
可视对讲交互事件通知
可视对讲通知地址配置
门禁批量管理
注册人员信息
批量注册人员信息
更新人员信息
查询人员列表
删除人员信息
批量下发
查询任务状态
查询任务详情
门禁计划
计划模板管理
周计划模板添加/更新
周计划模板获取
周计划模板删除
假日计划模板添加/更新
假日计划模板获取
假日计划模板删除
门禁计划管理
周计划配置
周计划获取
假日计划配置
假日计划获取
假日组计划配置
假日组计划获取
门禁计划配置
门禁计划聚合配置
门禁计划获取
清空门禁计划
超脑人脸管理
IO管理
获取设备IO端口状态
获取设备指定输出口信息
配置设备指定输出口信息
IO输出
人脸管理
删除人脸
查询人脸信息
查询人脸列表
人脸库管理
创建人脸库
查询人脸库容量
删除全部人脸库
删除指定人脸库
查询人脸库基本参数
设置人脸库基本参数
查询指定人脸库基本参数
设置指定人脸库基本参数
查询人脸比对参数
配置人脸比对参数
人员信息管理
注册人员信息
查询人员列表
注销人员信息
获取磁盘基本信息
下发任务管理
下发人脸
任务状态查询
人脸下发状态查询
删除任务
健康码分析能力
健康码识别
行程码识别
核酸报告识别
获取access_token
POST
能力概览
复制页面
设备管理能力
#
设备管理是平台其他业务能力的基础,在进行其他操作之前,首先需要将设备注册到平台上。
组织管理
#
1.提供简单的组织管理能力,主要用来对设备进行分组管理
2.若第三方自身系统有组织编号管理,我们同时也提供了支持组织编号的管理接口
3.目前组织层级最大支持5级,组织数量最大支持1000
设备管理
#
1.设备注册、注销、查询、修改
2.设备通道同步、查询
设备接入组网图
#
视频应用能力
#
视频控件
#
提供视频实时预览和录像回放查看的能力,通过集成web插件实现web端预览回放功能的开发
注:目前web插件只支持windows
应用场景举例:
#
用户希望在自己的平台上实时观看摄像头/监控点的视频信息,并查看历史录像的回放,开发流程如下:
1.将所有需要观看的监控点设备注册到平台上
2.调用接口关闭设备加密
3.登录开发者服务门户,进入下载页面下载web插件及demo,移动端集成则需要下载APP SDK及demo
4.按照demo中的接口调用流程调用相应的接口实现预览/回放功能
移动端SDK
#
提供视频实时预览和录像回放查看的能力,通过集成APPSDK实现移动端预览回放功能的开发
注:APPSDK只支持原生安卓、IOS系统
应用场景举例:
#
用户希望在自己的APP上实时观看摄像头/监控点的视频信息,并查看历史录像的回放,开发流程如下:
1.将所有需要观看的监控点设备注册到平台上
2.调用接口关闭设备加密
3.登录开发者服务门户,进入下载页面下载SDK及demo
4.按照demo中的接口调用流程调用相应的接口实现预览/回放功能
标准流预览
#
标准流预览是平台提供的最简易的视频接入方式,无需集成插件,简单几步即可观看设备视频。
标准流预览分为HLS和RTMP,HLS适用于移动端使用,可用微信直接打开,也可集成H5页面嵌入到微信小程序或者微信公众号中。RTMP适用于PC网页端使用,可用flash或者ckplayer等播放器嵌入网页的方式播放,较HLS延迟小,更稳定。
注:标准流预览目前只支持H264格式的码流,部分设备出厂默认是H265,需要在设备网页端修改配置
安全防盗:
#
标准流预览的特点是易于分享,但由于是标准协议,无法用于加密设备。所以我们提供了针对HLS标准流预览地址的防盗方法(RTMP暂不支持),既获取带有效期的标准流预览地址,过期后该地址将无法打开视频,需要重新获取新的地址。
应用场景举例:
#
某某学校需要做明厨亮灶,将厨房视频实时对外公开播放,开发流程如下:
1.将设备注册到平台上
2.调用接口关闭设备加密
3.调用接口设备开通标准流预览
4.调用接口获取标准流预览地址,将标准流预览地址集成到自己的应用中播放视频
互动直播间
#
直播间功能简化了集成开发的工作量,可提供直接在浏览器中观看的直播地址并可以进行直播互动
应用场景举例:
#
某商户希望将店铺场景向用户进行直播,并可以进行交流互动,对接流程如下:
1.将设备注册到平台上
2.调用接口关闭设备加密
3.调用直播间账户充值接口进行充值(充值卡密需要联系海康销售人员购买)
4.调用创建直播间接口创建一个直播间
5.将直播间地址直接分享给用户即可观看直播
UIKit
#
提供无插件方式实时预览和录像回放的能力,只需集成前端JS库而无需安装集成插件实现WEB端视频预览和回放功能的开发
注:视频预览时为了保证观看的流畅性,分辨率设置建议720P/1080P,码率1M以下,400万像素的设备码率设置在2M以下, 但是因为本地录像也会按照视频参数的设置来存储,当码率设置较低时可能会影响录像的质量,因此视频参数的设置需要综合考虑这2种情况来做均衡。
应用场景举例:
#
用户希望在自己的页面上采用无插件的方式实时观看摄像头/监控点的信息,并查看历史录像的回放,开发流程如下:
1.将所有需要观看的监控点设备注册到平台上
2.下载UIKit使用说明文档
点击下载
3.按照文档的指导流程进行相应接口的调用实现预览/回放功能
门禁/可视对讲设备能力
#
门禁设备目前支持设备型号为9613系列、9503系列、607系列
门禁权限管理
#
1.提供了门禁权限的下发和查询的功能,可以根据门禁的设备信息,人员卡片,人脸等信息,将权限下发至对应的设备,可应用于刷卡开门、刷脸开门场景
2.提供了生成访客二维码的功能,可根据卡号生成访客二维码,访客可出示二维码直接扫码开门
3.提供远程控门的功能,可应用于物业/服务中心远程开门
门禁事件上报
#
提供了门禁设备开门事件上报的功能,门禁事件产生之后,用户可获取到对应的开门事件记录,部分设备还可以支持开门时的实时抓图上报
开门事件的获取可参考消息通道文档
门禁管理组网图
#
可视对讲
#
提供手机与设备可视对讲的能力,通过集成APPSDK实现移动端可视对讲,开发流程如下:
1.将可视对讲设备注册到平台
2.设备拨房间号进行呼叫,平台将呼叫消息推送给第三方服务端
3.第三方服务端收到可视对讲消息之后推送给设备关联的用户移动端
4.移动端通过集成APPSDK实现可视对讲
可视对讲组网图
#
【海康云眸】API开发者 微信交流群
用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通
扫码加入交流群
修改于
2022-06-09 11:12:07
上一页
产品介绍
下一页
错误码表