全部产品

门禁管理服务

1.1 门禁智能通行记录

模型ID

版本

iotx_face_record_model

1.6

属性列表

属性名称

属性标识符

数据类型

数据描述

记录标示

eventId

String

记录标示

创建时间

gmtCreate

Date

创建时间

上报时间

eventTime

Date

上报时间

用户Id

userId

String

用户Id,

设备id

iotId

String

设备id

用户信息扩展信息

userExtInfo

String

用户扩展信息

设备扩展信息

deviceExtInfo

String

设备扩展信息

通行方式

mediaType

String

开门方式,例如face

抓拍图片

pictureUrl

String

抓拍图片URL

1.2 门禁传统通行记录

模型ID

版本

iot_entrance_event_model

1.1

属性列表

属性名称

属性标识符

数据类型

数据描述

必须

用户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

设备扩展信息

1.3生成二维码

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

path

版本

是否需要登录

/homelink/common/qrcode/generate

1.0.1

请求参数

参数

类型

是否必填

备注

identityId

String

申请二维码人员的统一身份ID

codeLength

Integer

二维码字符串长度默认16

返回结果

字段名

类型

备注

data

String

二维码内容字符串

1.4 二维码权限配置

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

path

版本

是否需要登录

/entrance/paas/perm/qrcode/config

1.0.1

请求参数

参数

类型

是否必填

备注

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

code

Integer

返回码

message

String

错误消息

iotId

String

设备iotId

1.5 二维码权限删除

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

path

版本

是否需要登录

/entrance/paas/perm/qrcode/remove

1.0.1

请求参数

参数

类型

是否必填

备注

qrCode

String

二维码

iotIds

JSONArray

待配置权限的门禁设备iotId

identityId

String

申请二维码人员的统一身份ID

返回结果

字段名

类型

备注

data

JSON

code

Integer

返回码

message

String

错误消息

iotId

String

设备iotId

1.6 用户权限配置

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

path

版本

是否需要登录

/face/paas/permission/add

1.0.0

请求参数

参数

类型

是否必填

备注

userType

String

默认填写IDENTITY

userIdList

JSONArray

用户ID列表

scopeType

String

默认填写IOT_ID

scopeIdList

JSONArray

信息下发的设备列表

返回结果

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

1.7 用户权限删除

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

path

版本

是否需要登录

/face/paas/permission/delete

1.0.0

请求参数

参数

类型

是否必填

备注

userType

String

默认填写IDENTITY

userIdList

JSONArray

用户ID列表

scopeType

String

默认填写IOT_ID

scopeIdList

JSONArray

信息下发的设备列表

返回结果

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

1.8 查询用户和设备的权限关系

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

path

版本

是否需要登录

/face/paas/permission/querybyuser

1.0.4

请求参数

参数

类型

是否必填

备注

userType

String

默认填写IDENTITY

userId

String

用户ID

deviceListPageNo

Integer

分页查询的请求页码

deviceListPageSize

Integer

分页查询的请求页大小

statusList

JsonArray

状态列表:

详见下发状态定义

下发状态定义

状态

定义

toBeTransferred

等待下发

transferring

下发中

deviceOffline

设备离线或者设备异常

transferred

下发完成

faceCheckTimeout

下发失败,提取特征值超时

faceDlError

下发失败,下载图片失败

faceCheckError

下发失败,提取特征值失败或其他未知原因

facePushError

下发失败,推送到终端设备出错

unknownError

下发失败,设备端未返回结果,原因未知

transferDeleted

删除成功

deleteFailed

删除失败

transferTimeout

下发超时

deleteTimeout

删除超时

返回结果使用通用结果类型,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、下发时间、下发状态

iotId

String

设备Id

syncTime

String

下发时间

status

String

详见下发状态定义

deviceNickName

String

设备昵称

cron

String

有效期表达式

1.9 根据设备查询用户权限

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

path

版本

是否需要登录

/face/paas/permission/querybydevice

1.0.4

请求

参数

参数

类型

是否必填

备注

iotId

String

设备iotId

pageNo

Integer

分页查询的请求页码

pageSize

Integer

分页查询的请求页大小

statusList

JsonArray

状态列表:

详见下发状态定义

返回结果

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

参数

类型

备注

total

Long

下发到该设备的用户图片总数

pageNo

Integer

请求页码

pageSize

Integer

请求页大小

data

JsonArray

用户列表

userType

String

默认填写IDENTITY

userId

String

用户ID

userName

String

用户姓名,不超过64字符

expiredTime

String

图片有效期,时间格式yyyy-MM-dd HH:mm:ss

extInfo

String

业务扩展字段,不超过1024字符

syncTime

String

图片下发时间

status

String

下发状态:

详见下发状态定义

cron

String

有效期表达式

1.10 远程开门服务

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

path

版本

是否需要登录

/cloud/thing/service/invoke

1.0.1

请求参数

参数

类型

是否必填

备注

iotId

String

门禁设备的iotId

identifier

String

固定值“remoteOpen”

args

JSNOObject

固定值{}

返回结果

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

1.11生成加密二维码

通过1.3生成的非加密二维码进行RSA密钥加密,生成88位的加密二维码,该二维码用于展示后给设备端扫码使用

path

版本

是否需要登录

/entrance/paas/perm/qrcode/encrypt

1.0.0

请求参数

参数

类型

是否必填

备注

identityId

String

二维码对应用户id

qrCode

String

二维码字符串

expiryTime

String

二维码失效时间,格式:

yyyy-MM-dd HH:mm:ss

返回结果

字段名

类型

备注

data

String

加密二维码字符串