目录

案例1、如何通过iSC平台openAPI接口实现访客预约功能

案例2、(普通访客场景)自主开发访客客户端实现先线上预约再现场登记

案例3、(临时访客场景)自主开发访客客户端实现临时来访现场登记

案例4、预约后无需现场登记访客场景

---

案例1、如何通过iSC平台openAPI接口实现访客预约功能

【访客应用普通场景】项目上经常碰到第三方对接ISC平台OPENAPI实现访客预约功能，访客预约功能实际是将访客信息（卡号、车牌号、人脸）下发到对应资源中，资源类型包括门禁设备、梯控设备、可视对讲设备、停车场等。现将预约基本流程与常见问题作一说明。

 

1、接口调用流程

接口调用流程分为两种情况，一种是项目现场有访客登记机设备，一种是没有访客登记机。访客登记机设备一般放置在大门保安室中，是用来实现登记功能。访客预约完整流程分为预约与登记，只有登记后访客的权限信息才会下发到对应设备中。

1) 无访客登记机设备

第一步：直接调用“预约免登记”接口。接口请求参数中传入访客信息以及访客权限组信息，访客权限组需要在平台访客管理界面提前配置好，里面添加的是对应的资源类型。如下图：

 

第二步：调用“查询访客权限下载记录”接口查询访客权限下发结果。如果都下发成功，那么访客即可拿着对应的凭证（人脸、二维码、车牌号或者身份证）通过对应的设备；如果查不到该访客的权限下发记录，请检查调用”预约免登记”接口中请求参数visitorPermissionSet是否指定了权限组。如果未指定，请确保平台上配置了默认权限组，否则会导致该访客无任何权限。

 

2)有访客登记机设备
此种情况直接调用“访客预约v2”接口，再拿着此接口返回的verificationCode去访客登记机上进行登记，登记机上选择访客权限组。

案例2、(普通访客场景)自主开发访客客户端实现先线上预约再现场登记

【应用场景】自主开发访客客户端实现先线上预约再现场登记。

【流程描述】

1、预约阶段

调用【访客预约v2】接口发起预约， 调用【查询访客预约记录v2】接口可以查看访客的预约记录。
调用【修改访客预约v2】接口可以修改预约单信息，调用【取消访客预约】接口取消预约。

 

2、来访阶段

1)登记：访客来访时需要登记，调用【已预约登记】接口进行登记并下发权限(如果涉及到权限配置，可以先调用【查询访客权限组】接口，然后在登记时指定访客权限组参数)。
2)访客进入访客区：使用的动态二维码凭证，可以调用【生成访客动态二维码内容】接口拿到动态二维码内容)。
如果访客开门权限认证失败，可以通过【查询访客权限下载记录】接口查询权限下发情况，如果权限下发失败，可以调用【访客权限重新下发】接口重新下发权限。
3)离开:访客正常访问结束之后，可以调用【访客签离】接口进行访客签离，实现权限回收，记录访客离开时间。

 

3、后期数据分析阶段
访问结束后，可以调用【查询访客来访记录v2】查看访客来访记录信息；调用【查询访客出入事件】获取访客的进出记录；调用【获取访客记录中的图片】接口获取访客相关图片进行展示。

案例3、(临时访客场景)自主开发访客客户端实现临时来访现场登记

【应用场景】自主开发访客客户端实现临时来访现场登记。

【流程描述】

 

1、来访阶段
1)登记：访客临时来访需要登记时，调用【未预约登记】接口进行登记并下发权限(如果涉及到权限配置，可以先调用【查询访客权限组】接口，然后在登记时指定访客权限组参数)。
2)访客进入访客区：访客登记之后，根据各种凭证进行开门，开闸等操作，然后进入访客区(如果使用的动态二维码凭证，可以调用【生成访客动态二维码内容】接口拿到动态二维码内容)。如果访客开门权限认证失败，可以通过【查询访客权限下载记录】接口查询权限下发情况，如果权限下发失败，可以调用【访客权限重新下发】接口重新下发权限。
3)离开:访客正常访问结束之后，可以调用【访客签离】接口进行访客签离，实现权限回收，记录访客离开时间。

2、后期数据分析阶段
访问结束后，可以调用【查询访客来访记录v2】查看访客来访记录信息；调用【查询访客出入事件】获取访客的进出记录；调用【获取访客记录中的图片】接口获取访客相关图片进行展示。

案例4、预约后无需现场登记访客场景

【应用场景】没有访客机,线上预约登记并下发访客权限。

【流程描述】

 

1、预约阶段
调用【预约免登记】接口发起预约(预约免登记意思就是预约后自动登记了，同时会根据接口入参中指定访客权限组参数下发访客权限)， 调用【查询访客预约记录v2】接口可以查看访客的预约记录。
调用【修改访客预约v2】接口可以修改预约单信息，调用【取消访客预约】接口取消预约。
2、来访阶段
1）登记访客进入访客区：访客登记之后，根据各种凭证进行开门，开闸等操作，然后进入访客区(如果使用的动态二维码凭证，可以调用【生成访客动态二维码内容】接口拿到动态二维码内容。如果访客开门权限认证失败，可以通过【查询访客权限下载记录】接口查询权限下发情况，如果权限下发失败，可以调用【访客权限重新下发】接口重新下发权限。
2）离开：访客正常访问结束之后，可以调用【访客签离】接口进行访客签离，实现权限回收，记录访客离开时间。

3、后期数据分析阶段
访问结束后，可以调用【查询访客来访记录v2】查看访客来访记录信息；调用【查询访客出入事件】获取访客的进出记录；调用【获取访客记录中的图片】接口获取访客相关图片进行展示。

【常见问题自查方法】
1、若有明显报错，请先输入错误码进行机器人自助查询，例如：0x02401008
2、若是调用某接口产生的问题，请尝试先输入接口名称或者接口地址进行自助查询，例如：查询门禁点事件v2 或 /api/acs/v2/door/events
3、尝试向机器人描述您的问题
操作举例如下：