全部产品
云市场

门禁服务

更新时间:2020-03-24 20:44:39

1门禁刷脸通行记录

模型ID 版本
iotx_face_record_model 1.2

属性列表

属性名称 属性标识符 数据类型 数据描述
记录标示 eventId String 记录标示
创建时间 gmtCreate Date 创建时间
上报时间 eventTime Date 上报时间
用户Id userId String 用户Id,
设备id iotId String 设备id
用户信息扩展信息 userExtInfo String 用户扩展信息
设备扩展信息 deviceExtInfo String 设备扩展信息
通行方式 mediaType String 开门方式,例如face
人脸抓拍图片 pictureUrl String 人脸抓拍图片URL

2门禁非人脸通行记录

模型ID 版本
iot_entrance_event_model 1.0

属性列表

属性名称 属性标识符 数据类型 数据描述 必须
用户id identityId String 用户id
用户姓名 name String 用户姓名
事件时间 time Date 事件时间
设备id iotId String 设备id
通行类型 type String 通行类型 - CARD门禁卡- PASSWORD密码- QRCODE二维码
密码号码 number String 密码号码
门禁卡号 cardId String 门禁卡号,只有type是CARD的时候有效
通行方向 direction String 通行方向,ENTRANCE 进, EXIT 出
用户扩展信息 userExtInfo String 用户扩展信息
设备扩展信息 devExtInfo String 设备扩展信息

3生成二维码

生成访客二维码,首先需要在用户组中添加访客组,并且在组内添加相应的人员信息获取到identityId。

path 版本 是否需要登录
/homelink/common/qrcode/generate 1.0.0

请求参数

参数 类型 是否必填 备注
identityId String 申请二维码人员的统一身份ID

返回结果

字段名 类型 备注
data String 二维码内容字符串

4二维码权限配置

将二维码绑定到门禁设备上,系统会根据绑定关系下发到指定设备中。

path 版本 是否需要登录
/entrance/paas/perm/qrcode/config 1.0.0

请求参数

参数 类型 是否必填 备注
qrCode String 二维码
iotIds JSONArray 待配置权限的门禁设备iotId
identityId String 申请二维码人员的统一身份ID
effectiveTime String 二维码生效期,时间格式 yyyy-MM-dd HH:mm:ss 默认为当前时间
expiryTime String 二维码失效期,时间格式 yyyy-MM-dd HH:mm:ss 不能超过当前时间
maxScanTimes Integer 最大刷卡次数,默认为-1不做次数限制
maxScanScope String 最大刷码次数作用范围,默认为每个设备独立计数。SHARE –共享; DEVICE – 设备

返回结果

字段名 类型 备注
data JSON

5二维码权限删除

将二维码从门禁设备中删除。

path 版本 是否需要登录
/entrance/paas/perm/qrcode/remove 1.0.0

请求参数

参数 类型 是否必填 备注
qrCode String 二维码
iotIds JSONArray 待配置权限的门禁设备iotId
identityId String 申请二维码人员的统一身份ID

返回结果

字段名 类型 备注
data JSON


6人脸权限配置

将已保存的用户人脸图片下发到设备端,使设备有权限识别对应的人脸用户。支持从设备维度和空间维度进行下发。

path 版本 是否需要登录
/face/paas/permission/add 1.0.0

请求参数

参数 类型 是否必填 备注
userType String 默认填写IDENTITY
userIdList JSONArray 用户ID列表
scopeType String 默认填写IOT_ID
scopeIdList JSONArray 人脸信息下发的设备列表

返回结果

返回结果使用通用结果类型,不使用data域。

7人脸权限删除

将已保存的用户人脸图片从设备端删除,使设备无权限识别对应的人脸用户。支持从设备维度和空间维度进行删除。

path 版本 是否需要登录
/face/paas/permission/delete 1.0.0

请求参数

参数 类型 是否必填 备注
userType String 默认填写IDENTITY
userIdList JSONArray 用户ID列表
scopeType String 默认填写IOT_ID
scopeIdList JSONArray 人脸信息下发的设备列表

返回结果

返回结果使用通用结果类型,不使用data域。

8查询人脸和设备的权限关系

根据用户id和用户类型查询人脸图片信息及其下发的设备列表(含下发状态)。

path 版本 是否需要登录
/face/paas/permission/querybyuser 1.0.0

请求参数

参数 类型 是否必填 备注
userType String 默认填写IDENTITY
userId String 用户ID
deviceListPageNo Integer 分页查询的请求页码
deviceListPageSize Integer 分页查询的请求页大小

返回结果

返回结果使用通用结果类型,data域是对象,见下表的详细说明:

参数 类型 备注
userType String 默认填写IDENTITY
userId String 用户ID
userName String 用户姓名,不超过64字符
expiredTime String 人脸图片有效期,时间格式yyyy-MM-dd HH:mm:ss
extInfo String 业务扩展字段,不超过1024字符
deviceListTotal Integer 该用户人脸图片执行过下发操作的设备总数
deviceListPageNo Integer 请求页码
deviceListPageSize Integer 请求页大小
deviceList JSONArray 设备列表,包含设备iotId、下发时间、下发状态