海康威视开放平台门禁权限管控案例说明

目录

案例1、出入权限配置及下发

案例2、指定人员和设备下发权限

---

案例1、出入权限配置及下发

【相关接口说明】可以在开放网站上进行仔细查看。

【流程描述】

1、基础数据准备
准备好待下发的人员及人脸信息以及对应的设备(门禁、可视对讲、梯控)。
2、平台配置阶段
调用【添加权限配置】接口，配置人或组织的门禁相关资源权限。
通过【查询权限配置单进度】接口查询权限配置进度，通过【查询权限配置】接口查看权限配置结果。
调用【删除权限配置】接口，可以删除已配置好的权限。
3、配置下发阶段
配置好权限后还需要执行权限、人脸下发才能在门禁相关设备上生效，提供了两种方法下载：

1）快捷模式下载：适用于按照设备类型全量下发对应设备上的权限配置。
     调用【根据出入权限配置快捷下载】接口实现异步下载；

2）任务模式下载：适用于多种设备类型非全量下发权限配置。
     调用【创建下载任务_根据出入权限配置下载】创建任务；
     多次调用【添加待下载的设备通道_根据出入权限配置下载】接口向任务内添加需要下发权限的设备列表；
     调用【开始下载任务】接口开始下载任务中添加的设备列表的权限配置；

4、任务下发结果查看阶段
通过【查询下载任务进度】查询下载进度,调用【查询设备通道权限下载记录列表】和【查询设备通道的人员权限下载详情v2】接口，查看具体人员到对应设备上的权限下载结果。

【应用场景】综合大楼、学校、医院等场景的大批量权限配置及下发

  举例1：XXX学校项目，疫情期间学校要控制学生每天的进出限制，如果需要进出学校的门禁权限，需要提前一天申请第二天的进出门禁权限，每天大约有3000人的权限要下发到20台设备上。

  需求分析：

分类	实际需求
权限申请时间	提前一天
权限生效时间	第二天生效(不需要实时下发)
权限条目数量	大批量，大约6W(3000人*20台设备)

  针对需求简要分析后，我们可以使用“权限配置及下发”的流程来下发，添加权限配置按需求实时调用接口进行添加配置，再设置定时任务，指定需要下发权限的设备列表开始执行下发

  权限配置

  学生提交申请权限时，调用【添加权限配置】的接口给学生分配对应门禁设备的权限，同时上层业务平台记录配置的权限条目(学生对应的门禁设备权限记录)；由于添加权限配置是异步接口，权限配置的结果需要通过【查询权限配置单进度】接口查询配置是否完成，尤其是大批量配置权限的情况；

  权限下载

  1)通过定时任务周期性(例如每小时执行一次下载)的指定要下发权限的门禁设备列表，调用【根据出入权限配置快捷下载】接口传入需要下发的门禁设备列表开始下发配置给对应设备上的权限条目；
  2)根据出入权限配置快捷下载的接口也是异步下发，设备上的权限下载进度需要周期性(例如每5s或者10s查询下)的调用【查询下载任务进度】接口查询，直到进度返回100才算下载完成；
  3)下载进度完成后，可以调用【查询设备通道权限下载记录列表】和【查询设备通道的人员权限下载详情v2】接口查看具体人员到对应设备上的权限下载结果。

案例2、指定人员和设备下发权限

【相关接口说明】可以在开放网站上进行仔细查看。

【流程描述】

1、异步下载：适用于不同的人拥有不同设备权限的大批量权限下发场景。
      step1：配置下发阶段
                  调用【创建下载任务_根据人员与设备通道指定下载】创建任务；
                  多次调用【下载任务中添加数据_根据人员与设备通道指定下载】接口向任务内添加人员对应的门禁设备的权限记录；
                  调用【开始下载任务】接口开始下载任务中添加的人员门禁设备权限数据。
      step2：任务下发结果查看阶段
                  通过【查询下载任务进度】查询下载进度，调用【查询设备通道权限下载记录列表】和【查询设备通道的人员权限下载详情v2】接口，查看具体人员。

2、同步下载：适用于直接下载某个人的权限到某个设备上的场景。
                  调用【简单同步权限下载_根据人员与设备通道指定下载】接口指定要下发的人员和对应的门禁设备实现单个人员到单个设备的权限下发。

【应用场景】不配置权限直接指定人员和设备下发权限

  举例1、XXX物流仓库项目，需要给临时工下发进出仓库的权限，由于临时工一大部分都是临时来报名提供个人信息后就需要把权限及人脸信息及时下发到仓库的门禁设备上(每天大约2000人下发到100台设备)，同时剩余的一大部分都是提前报名提供个人信息，进出仓库的门禁权限需要第二天或者之后才生效(每天大约3000人下发到100台设备)。

  需求分析：两种权限需求分两种方式下发：

实时性要求高的权限
生效时间	权限申请后需要及时生效，实时性要求较高
权限条目数量	大批量，大约20W(2000人*100台设备)
实时性要求不高的权限
生效时间	提前申请权限需要第二天生效，实时性要求不高
权限条目数量	大批量，大约30W(3000人*100台设备)

  调用流程：

  1)实时性要求较高的权限

1	上层业务平台把人员、人脸等基础信息同步到我们海康平台后，记录需要下发的权限条目(人员对应的门禁设备权限记录)；
2	通过定时任务周期性(例如5分钟)开始执行“设备权限下发-异步下载”
3	•调用【创建下载任务_根据人员与设备通道指定下载】接口创建下载任务；
4	•上层业务平台汇总出最近一个周期内(例如最近5分钟内)需要及时下发的权限条目，多次调用【下载任务中添加数据_根据人员与设备通道指定下载】接口向任务内添加本次需要下发的人员对应门禁设备的权限记录；
5	•调用【开始下载任务】接口开始下载任务中添加的人员的门禁设备权限数据；
6	•任务下载是异步下发，设备上的权限下载进度需要周期性(例如每5s或者10s查询下)的调用【查询下载任务进度】接口查询，直到进度返回100才算下载完成；
7	•下载进度完成后，可以调用【查询设备通道权限下载记录列表】和【查询设备通道的人员权限下载详情v2】接口查看具体人员到对应设备上的权限下载结果。

   2)实时性要求不高的权限

    a.权限配置：

   上层业务平台把人员、人脸等基础信息同步到我们海康平台后，调用【添加权限配置】的接口给人员分配对应门禁设备的权限，同时上层业务平台记录配置的权限条目(人员对应的门禁设备权限记录)；由于添加权限配置是异步接口，权限配置的结果需要通过【查询权限配置单进度】接口查询配置是否完成，尤其是大批量配置权限的情况；

    b.权限下载：

    通过定时任务避开实时权限高峰期定时执行(例如每天晚上空闲时间等)的指定要下发权限的门禁设备列表，调用【根据出入权限配置快捷下载】接口传入需要下发的门禁设备列表开始下发配置给对应设备上的权限条目；

    根据出入权限配置快捷下载的接口也是异步下发，设备上的权限下载进度需要周期性(例如每5s或者10s查询下)的调用【查询下载任务进度】接口查询，直到进度返回100才算下载完成；

    下载进度完成后，可以调用【查询设备通道权限下载记录列表】和【查询设备通道的人员权限下载详情v2】接口查看具体人员到对应设备上的权限下载结果。