接口说明
按人员授权接口,支持批量授权,人员所带的卡、指纹、人脸会自动下发
新增的卡、指纹、人脸也会自动下发,无需额外授权
人员数量*门禁通道数量(门组则计算出来 相应的通道数)不能超过50万
前置条件
前置条件
人员必须存在,新增人员与授权需间隔一定时间,推荐5秒
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/personAuthority/batchAuthority
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
personCodes | 是 | array | 1000 | 人员编号列表,参考人员分页查询获取 接口获取 |
timeQuantumId | 是 | long | - | 时间计划ID,调用时间计划列表接口获取时间计划,1表示默认时间计划,若需自定义权限生效范围,可调用添加时间计划接口新增时间计划 |
privilegeDetails | 是 | array | 1000 | 授权对象 |
+privilegeType | 是 | int | - | 授权方式:1-通道,2-门组 |
+resourceCode | 是 | string | 64 | 通道编码或门组ID,门禁点授权,调用设备管理接口,获取unitType为7的通道编码, 门组授权,调用门组列表接口查询门组ID |
+timeQuantumId | 否 | string | - | 时间计划,优先级高于外层时间计划 |
请求示例
{
"personCodes": [
"FB101000",
"FB101001"
],
"timeQuantumId": 1,
"privilegeDetails": [
{
"privilegeType": 1,
"timeQuantumId": 1,
"resourceCode": "1003815$7$0$0"
},
{
"privilegeType": 2,
"timeQuantumId": 1,
"resourceCode": 1
}
]
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | string | 错误码:0代表成功,非0具体错误码 |
errMsg | String | 错误信息 |
success | boolean | 请求是否成功 |
返回示例
{
"success": true,
"code": "0",
"errMsg": ""
}
接口说明
批量删除人员的所有权限,删除的权限包括:卡、指纹、人脸
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/personAuthority/deleteBatch
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
personCodes | 是 | array | 1000 | 人员编号列表,参考人员分页查询获取 接口获取 |
请求示例
{
"personCodes": [
"FB101000",
"FB100999"
]
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | String | 错误码 |
errMsg | String | 错误信息 |
success | boolean | 请求是否成功 |
返回示例
{
"code": "0",
"errMsg": "success",
"success": true
}
接口说明
删除单个人员权限
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/personAuthority/deleteSinglePrivilege
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
personCode | 是 | string | 64 | 人员编码,参考人员分页查询获取 接口获取 |
deleteDetails | 是 | array | 1000 | 需要删除的权限 |
+ resourceCode | 是 | string | 64 | 删除的对象:通道编号或者门组ID |
+ privilegeType | 是 | int | - | 授权方式: 1-通道,2-门组 |
请求示例
{
"personCode": "FB101000",
"deleteDetails": [
{
"privilegeType": 1,
"resourceCode": "1003815$7$0$0", // 通道编码
"resourceName": "520409_通道1" // 通道名称
},
{
"privilegeType": 2,
"resourceCode": "1", // 门组ID
"resourceName": "通行门组" // 门组名称
}
]
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | string | 错误码 |
errMsg | string | 错误信息 |
success | boolean | 请求是否成功 |
返回示例
{
"success": true,
"code": "0",
"errMsg": ""
}
接口说明
查询授权信息(包含人员拥有的所有权限信息), 支持分页
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/syncMultiple/page
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
personCode | 否 | string | 64 | 人员编号,参考人员分页查询获取 接口获取 |
deviceCode | 否 | string | 64 | 设备编号,参考设备分页查询 接口或设备树查询接口获取 |
channelCode | 否 | string | 64 | 通道编号,参考设备通道分页查询 接口或设备树查询接口获取 |
pageNum | 是 | int | - | 页码,大于0 |
pageSize | 是 | int | - | 每页记录数,大于0,最大支持100 |
请求示例
{
"personCode": "FB100999",
"pageNum": 1,
"pageSize": 20
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
errMsg | string | 错误信息 |
success | boolean | 请求是否成功 |
code | string | 请求错误码 |
data | object | 返回数据 |
+ currentPage | int | 当前页 |
+ enableCloudDB | boolean | 是否支持云库 |
+ pageSize | int | 每页记录数 |
+ totalPage | int | 总条数 |
+ totalRows | int | 总记录数, -1 表示不支持查询总数 |
+ pageData | JSONArray | 分页数据 |
++ deptFullPathList | array | 所属部门完整路径 |
++ deptNameList | array | 所属部门名称 |
++ channelCode | string | 通道编码 |
++ channelName | string | 通道名称 |
++ deviceCode | string | 设备编码 |
++ personCode | string | 人员编码 |
++ personName | string | 人员名称 |
++ timeQuantumName | string | 开门计划名称 |
++ updateTime | timestamp | 更新时间,13位时间戳 |
++ orgName | string | 组织名称 |
++ facePath | string | 人脸图,相对路径,拼接方式可查看:FAQ-常见问题-图片服务-OSS方式 |
++ personSync | object | 人员任务 |
+++ syncFlag | string | 同步状态, 详见 同步状态字典 |
++ cardSyncList | array | 发卡任务 |
+++ cardNumber | string | 卡号 |
+++ syncFlag | string | 同步状态,详见 同步状态字典 |
+++ personReady | int | 是否已下发人员, 0-未下发, 1-已下发 |
++ faceSync | object | 人脸任务 |
+++ syncFlag | string | 同步状态,详见 同步状态字典 |
+++ personReady | int | 是否已下发人员, 0-未下发, 1-已下发 |
++ fingerSync | object | 指纹任务,不存在代表没有该类型的任务 |
+++ syncFlag | string | 同步状态,详见 同步状态字典 |
+++ personReady | int | 是否已下发人员, 0-未下发, 1-已下发 |
返回示例
{
"code": "0",
"data": {
"currentPage": 1,
"enableCloudDB": false,
"pageData": [
{
"cardSyncList": [
{
"cardNumber": "FB100999",
"personReady": 0,
"syncFlag": "5"
}
],
"channelCode": "1003410$7$0$0",
"channelName": "园区可视对讲门口机白光2504_数字门口机_白光_01001020504_门禁通道_1",
"deptFullPathList": [
"根部门/导入1k指纹"
],
"deptNameList": [
"导入1k指纹"
],
"deviceCode": "1003410",
"facePath": "b3092819-75d7-11ed-8897-d09466514986/20230104/1/e50ea597-8bd6-11ed-9f6c-d09466514986.jpg",
"faceSync": {
"personReady": 0,
"syncFlag": "5"
},
"fingerSync": {
"personReady": 0,
"syncFlag": "5"
},
"orgName": "vims",
"personCode": "FB100999",
"personName": "FB100999",
"personSync": {
"syncFlag": "5"
},
"timeQuantumName": "默认计划",
"updateTime": 1673495999000
}
],
"pageSize": 10,
"totalPage": 1,
"totalRows": -1
},
"errMsg": "success",
"success": true
}
接口说明
按人员编号查询人员的权限配置记录
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/personAuthority/{personCode}
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
personCode | 是 | string | 人员编号,参考人员分页查询获取 接口获取 |
请求示例
https://ip/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/personAuthority/C12345678
返回参数
参数名 | 类型 | 说明 |
---|---|---|
success | string | 请求是否成功 |
code | string | 请求失败错误码 |
errMsg | string | 失败原因 |
data | JSONObject | 查询结果 |
+id | Long | 记录ID |
+personCode | String | 人员编号 |
+authorizeStatus | String | 授权状态 1-未授权,2-已授权 |
+personPrivilegeDetails | JSONArray | 授权配置记录 |
++ privilegeType | Integer | 授权方式1-按通道授权,2-按门组授权 |
++ resourceCode | String | 授权通道编号/门组ID |
++ resourceName | String | 授权通道名称/门组名称 |
++ authorizeSource | String | 权限来源 1-按人授权,2-按部门授权 |
++ timeQuantumId | Long | 授权所用的时间计划ID |
++ timeQuantumName | String | 授权所用的时间计划名称 |
++ orgName | String | 通道或门组的所属组织名称 |
++ validDateType | Integer | 权限有效期来源 1-人员有效期,2-临时有效期 (15版本增) |
++ startDate | String | 权限有效期开始时间(yyyy-MM-dd HH:mm:ss) |
++ endDate | String | 权限有效期结束时间(yyyy-MM-dd HH:mm:ss) |
返回示例
{
"success": true,
"code": "0",
"errMsg": "",
"data": {
"id": 10,
"personCode": "C12345678",
"authorizeStatus": "2",
"personPrivilegeDetails": [
{
"privilegeType": 2,
"resourceCode": "1",
"resourceName": "门组A",
"authorizeSource": "1",
"startDate": "2023-12-22 00:00:00",
"endDate": "2033-12-22 23:59:59",
"timeQuantumId": 1,
"timeQuantumName": "默认计划",
"orgName": "根节点",
"validDateType": 1
},
{
"privilegeType": 1,
"resourceCode": "1004322$7$0$0",
"resourceName": "测试通道1",
"authorizeSource": "1",
"startDate": "2023-12-22 00:00:00",
"endDate": "2033-12-22 23:59:59",
"timeQuantumId": 1,
"timeQuantumName": "默认计划",
"orgName": "门禁设备",
"validDateType": 1
}
]
}
}
接口说明
按部门授权接口,支持多部门按通道和门组批量授权
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/deptAuthority
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
deptIds | 是 | array | 1000 | 部门ID,参考部门分页查询 接口或部门树查询接口获取 |
channelCodes | 否 | array | 1000 | 通道编码,调用设备管理接口,获取unitType为7的通道编码 |
doorGroupIds | 否 | array | 1000 | 门组ID,调用门组列表接口查询门组ID |
timeQuantumId | 是 | long | - | 时间计划ID,调用时间计划列表接口获取时间计划,1表示默认时间计划,若需自定义权限生效范围,可调用添加时间计划接口新增时间计划 |
请求示例
{
"deptIds": [3],
"channelCodes": ["1000357$7$0$0"],
"doorGroupIds": [1],
"timeQuantumId": 1
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | string | 错误码:0代表成功,非0具体错误码 |
errMsg | String | 错误信息 |
success | boolean | 请求是否成功 |
返回示例
{
"code": "0",
"errMsg": "success",
"success": true
}
接口说明
按部门删除授权接口
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/deptAuthority/delete
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
deptId | 是 | long | - | 部门ID,参考部门分页查询 接口或部门树查询接口获取 |
deleteChannelCodes | 否 | array | 1000 | 通道编码,调用查询部门权限配置接口返回结果中的channelCode |
deleteDoorGroupIds | 否 | array | 1000 | 门组ID,调用查询部门权限配置接口返回结果中的groupId |
请求示例
{
"deptId": 3,
"deleteChannelCodes": ["1000292$7$0$0"],
"deleteDoorGroupIds": [1]
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | string | 错误码:0代表成功,非0具体错误码 |
errMsg | String | 错误信息 |
success | boolean | 请求是否成功 |
返回示例
{
"code": "0",
"errMsg": "success",
"success": true
}
接口说明
查询部门权限配置,返回部门权限配置的通道或门组信息
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.14 及以上版本
门禁管理子系统 V1.1.4 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/deptAuthority/bycondition/combined
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
deptId | 是 | long | - | 部门ID,参考部门分页查询 接口或部门树查询接口获取 |
singleCondition | 否 | array | 64 | 通道名称或门组名称,忽略大小写 |
请求示例
{
"deptId": 3,
"singleCondition": "门组1"
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | string | 错误码:0代表成功,非0具体错误码 |
errMsg | string | 错误信息 |
success | boolean | 请求是否成功 |
data | array | 数据对象 |
+ channelCode | string | 通道编码 |
+ channelName | string | 通道名称 |
+ orgName | string | 组织名称 |
+ timeQuantumId | long | 时间计划ID |
+ timeQuantumName | string | 时间计划名称 |
+ groupId | long | 门组ID |
+ groupName | string | 门组名称 |
+ groupSize | int | 包含门禁通道的数量 |
返回示例
{
"code": "0",
"data": [{
"channelCode": "1000357$7$0$0",
"channelName": "10.55.37.14_门禁通道_1",
"orgName": "根节点",
"timeQuantumId": 1,
"timeQuantumName": "默认计划"
},
{
"groupId": 1,
"groupName": "门组1",
"groupSize": 1,
"timeQuantumId": 1,
"timeQuantumName": "默认计划"
}],
"errMsg": "success",
"success": true
}
接口说明
门禁授权结果通知,三方可通过订阅的方式,实时获取到门禁授权相关的结果通知。如:人员、卡片、人脸、指纹的下发状态等。
需要在系统配置-门禁管理页面,开启授权任务订阅推送使能开关
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6 及以上版本
门禁管理子系统 V1.0.3 及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-event/1.0.0/subscribe/mqinfo
请求Method
POST
数据提交格式
application/json
请求参数
事件订阅接口参数详见: 事件订阅
门禁授权状态订阅参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
+++category | 是 | string | 事件大类,business |
++++types | 是 | array | 业务类型:包含delivery-state.change即可 |
请求示例
{
"param": {
"monitors": [
{
"monitor": "http://10.35.111.10:8010/eventReceiveMsg/save",
"monitorType": "url",
"events": [
{
"category": "business",
"authorities": [
{
"types": [
"delivery-state.change"
]
}
]
}
]
}
],
"subsystem": {
"subsystemType": 0,
"name": "10.35.111.10_8010",
"magic": "10.35.111.10_8010"
}
}
}
返回参数(推送到配置的三方接口地址的消息体格式)
参数名 | 类型 | 说明 |
---|---|---|
id | long | ID |
category | string | 事件大类 |
method | string | 业务类型 |
subsystem | string | 所属子系统 |
info | object | 数据对象 |
+deviceType | int | 1-一代设备,2-二代设备 |
+operateType | int | 操作类型,1-增加,2-删除,3-修改 |
+syncFlags | string | 下发结果:1-成功,2-下发中,3-下发失败,4-设备离线(仅卡任务有),5-等待下发 |
+eventType | int | 事件类型,1-人,2-卡,3-脸,4-指纹 |
+personCode | string | 人员编号 |
+cardNumber | string | 卡号 |
+channelCode | string | 通道编码 |
+errMsg | string | 错误信息 |
返回示例
{
"id": 37,
"category": "business",
"info": {
"deviceType": 2,
"operateType": 2,
"syncFlags": "1",
"eventType": 2,
"cardNumber": "B25F6B1B",
"personCode": "00001",
"channelCode": "1080851$7$0$0"
},
"method": "delivery-state.change",
"subsystem": "evo-accesscontrol"
}
接口说明
配置门禁权限后,可主动调用该接口获取权限下发的进度
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6 及以上版本
门禁管理子系统 V1.0.3 及以上版本
接口版本
1.0.3
接口URL
/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/authProcess/bath
请求Method
POST
数据提交格式
application/json
请求参数
参数名 | 必选 | 类型 | 长度 | 说明 |
---|---|---|---|---|
personCodes | 是 | array | 1000 | 人员编号,参考人员分页查询获取 接口获取 |
channelCodes | 是 | array | 1000 | 通道编号,参考设备通道分页查询 接口或设备树查询接口获取; 注意:事件类型为卡片类型生效 |
eventTypes | 是 | array | 4 | 事件类型:1-人员,2-卡片,3-人脸,4-指纹 |
operateTypes | 否 | array | - | 操作类型:1-增加,2-删除,3-修改 |
请求示例
{
"personCodes": ["zjw22", "1002"],
"channelCodes": ["1000128$7$0$0"],
"eventTypes": [2]
}
返回参数
参数 | 类型 | 描述 |
---|---|---|
code | string | 响应码 |
errMsg | string | 请求结果信息 |
success | string | 添加设备是否成功 |
data | List | 进度里列表 |
+syncFlag | String | 下发结果:1-成功,2-下发中,3-下发失败,4-设备离线(仅卡任务有),5-等待下发 |
+channelCode | String | 通道编号,事件类型为卡片时,即eventType=2时生效 |
+deviceCode | String | 设备编号,事件类型为人员、人脸、指纹时,即eventType=1、3、4时生效 |
+cardNumber | String | 卡号(仅卡任务有) |
+eventType | int | 事件类型:1-人员,2-卡片,3-人脸,4-指纹 |
+operateType | int | 操作类型:1-增加,2-删除,3-修改 |
+errMsg | string | 下发失败原因 |
+deviceType | string | 设备类型:1-一代设备,2-二代设备 |
+personCode | string | 人员编号 |
返回示例
{
"code": "0",
"data": [{
"eventType": 1,
"personCode": "zjw22",
"deviceCode": "1000128",
"channelCode": "0",
"deviceType": 2,
"operateType": 1,
"syncFlag": "1"
},
{
"eventType": 2,
"cardNumber": "AD126548AD",
"channelCode": "1000128$7$0$0",
"deviceCode": "1000128",
"deviceType": 2,
"errMsg": "",
"operateType": 1,
"personCode": "zjw22",
"syncFlag": "1"
}
],
"errMsg": "success",
"success": true
}