简体中文
简体中文
English
联系我们
注册
登录

配置门禁

更新时间:2023-01-12 07:14:25下载pdf

API 列表

请求方式 API 描述
POST /v1.0/iot-02/building/access-controls 添加门禁
PUT /v1.0/iot-02/building/access-controls 编辑门禁
POST /v1.0/iot-02/building/access-controls/actions/batch-delete 删除门禁
POST /v1.0/iot-02/building/access-controls/actions/edit-readers 编辑读头
POST /v1.0/iot-02/building/access-controls/actions/clear-configs 清除门禁配置
GET /v1.0/iot-02/building/access-controls/actions/simple-infos 获取门禁基本信息
PUT /v1.0/iot-02/building/access-controls/actions/edit-device 编辑门禁控制器
POST /v1.0/iot-02/building/access-controls/actions/batch-move 批量移动门禁
GET /v1.0/iot-02/building/access-controls/actions/config-infos 获取门禁配置详情
GET /v1.0/iot-02/building/access-controls 获取门禁列表
GET /v1.0/iot-02/building/access-controls/{access_control_id} 获取门禁详情
GET /v1.0/iot-02/building/access-control-devices 获取未绑定的门禁设备列表

添加门禁

功能描述

添加门禁。

接口地址

POST /v1.0/iot-02/building/access-controls

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlName String body 门禁名称
accessControlType Integer body 门禁类型
accessControlTypeStr String body 门禁类型名称
accessControlModel String body 门禁型号
accessControlFactory String body 门禁厂家
roomId String body 安装位置
deviceId String body 门禁控制器设备 ID
deviceName String body 门禁控制器设备名称
deviceSourceType String body 设备来源类型,1:非标准协议,2:标准协议

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

String{}

请求示例

{
    "cid":"",
    "deviceId":"6c04c99318f080ffc8p***",
    "deviceMac":"0005",
    "deviceName":"智能门锁(Lora) 3",
    "deviceSn":"","deviceSourceType":"2",
    "deviceStatus":1,
    "firstOnlineTime":1659431459133,
    "ipAddress":"",
    "lastOnlineTime":1660219064232,
    "projectId":"1424615984265764****",
    "accessControlName":"测试",
    "accessControlType":4,
    "accessControlModel":"12345",
    "accessControlFactory":"制造商 A",
    "accessControlTypeStr":"门禁一体机",
    "roomId":"1424637349790294***"
}

响应示例

String{}

编辑门禁

功能描述

编辑门禁。

接口地址

PUT /v1.0/iot-02/building/access-controls

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlName String body 门禁名称
accessControlType Integer body 门禁类型
accessControlTypeStr String body 门禁类型名称
accessControlModel String body 门禁型号
accessControlFactory String body 门禁厂家
roomId String body 安装位置
deviceId String body 门禁控制器设备 ID
deviceName String body 门禁控制器设备名称
deviceSourceType String body 设备来源类型,1:非标准协议,2:标准协议
accessControlId String body 门禁 ID
needLog boolean body 冗余字段:是否需要记录日志

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
    "accessControlId":"1567349953007718***",
    "cid":"",
    "deviceId":"6c04c99318f080ffc8p***",
    "deviceMac":"0005",
    "deviceName":"智能门锁(Lora) 3",
    "deviceSn":"",
    "deviceSourceType":"2",
    "deviceStatus":1,
    "firstOnlineTime":1659431459133,
    "ipAddress":"",
    "lastOnlineTime":1662535418079,
    "projectId":"1424615984265764864",
    "accessControlName":"测试修改",
    "accessControlType":4,
    "accessControlModel":"12345",
    "accessControlFactory":"制造商 B",
    "accessControlTypeStr":"门禁一体机",
    "roomId":"1424637349790294***"
}

响应示例

boolean{}

删除门禁

功能描述

删除门禁。

接口地址

POST /v1.0/iot-02/building/access-controls/actions/batch-delete

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlIds String[] body 门禁 ID 列表

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
  "accessControlIds": "门禁 ID 列表",
  "projectId": "项目 ID"
}

响应示例

boolean{}

编辑读头

功能描述

编辑读头。

接口地址

POST /v1.0/iot-02/building/access-controls/actions/edit-readers

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlId String body 门禁 ID
accessControlChannelId String body 门禁出入口 ID
accessControlReaderId String body 读头 ID
readerName String body 读头名称
readerType String body 读头类型,self:自身,button:开门按钮
readerDirection Integer body 读头标识,0:进,1:出
readerModel String body 读头型号
readerFactory String body 读头厂家
roomId String body 门禁读头安装空间 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

String{}

请求示例

{
    "readerType":"self",
    "accessControlChannelId":"1567458975220301***",
    "readerName":"测试读头",
    "readerModel":"12345",
    "readerFactory":"制造商 B",
    "readerDirection":0,
    "accessControlId":"1567349953007718***",
    "roomId":"1424637349790294***",
    "readerNo":1,
    "projectId":"1424615984265764***"
}

响应示例

String{}

清除门禁配置

功能描述

清除门禁配置。

接口地址

POST /v1.0/iot-02/building/access-controls/actions/clear-configs

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
clearConfigId String body 需要清除配置的 ID(门禁 ID/出入口 ID/读头 ID)
type Integer body ID 类型。1:门禁 ID,2:出入口 ID,3:读头 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
  "clearConfigId": "需要清除配置的 ID(门禁 ID/出入口 ID/读头 ID)",
  "type": "ID 类型。1:门禁 ID,2:出入口 ID,3:读头 ID",
  "projectId": "项目 ID"
}

响应示例

boolean{}

获取门禁基本信息

功能描述

获取门禁基本信息。

接口地址

GET /v1.0/iot-02/building/access-controls/actions/simple-infos

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlId String body 门禁 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "projectId": "String //项目 ID",
  "accessControlId": "String //门禁 ID",
  "accessControlName": "String //门禁名称",
  "accessControlType": "int //门禁类型",
  "accessControlModel": "String //门禁型号",
  "accessControlFactory": "String //门禁厂家",
  "roomId": "String //门禁安装空间 ID",
  "positionPath": "String //门禁安装位置"
}

请求示例

{
  "projectId": "项目 ID",
  "accessControlId": "门禁 ID"
}

响应示例

{
  "projectId": "项目 ID",
  "accessControlId": "门禁 ID",
  "accessControlName": "门禁名称",
  "accessControlType": "门禁类型",
  "accessControlModel": "门禁型号",
  "accessControlFactory": "门禁厂家",
  "roomId": "门禁安装空间 ID",
  "positionPath": "门禁安装位置"
}

编辑门禁控制器

功能描述

编辑门禁控制器。

接口地址

PUT /v1.0/iot-02/building/access-controls/actions/edit-device

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
deviceId String body 门禁控制器设备 ID
deviceName String body 门禁控制器名称

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
    "deviceId":"6c645765f8efb40667w***",
    "deviceName":"悉尔可视门禁 3",
    "projectId":"1424615984265764***"
}

响应示例

boolean{}

批量移动门禁

功能描述

批量移动门禁。

接口地址

POST /v1.0/iot-02/building/access-controls/actions/batch-move

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlIds String[] body 门禁 ID 列表
roomId String body 房间 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
  "accessControlIds": "门禁 ID 列表",
  "projectId": "项目 ID",
  "roomId": "房间 ID"
}

响应示例

boolean{}

获取门禁配置详情

功能描述

获取门禁配置详情。

接口地址

GET /v1.0/iot-02/building/access-controls/actions/config-infos

请求参数

参数名 类型 参数类型 说明 是否必需
accessControlId String body 门禁 ID
projectId String body 项目 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功,true:成功,false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "projectId": "String //项目 ID",
  "accessControlId": "String //门禁 ID",
  "accessControlDeviceVO": {
    "projectId": "String //项目 ID",
    "accessControlId": "String //门禁 ID",
    "deviceId": "String //设备 ID",
    "deviceName": "String //设备名称",
    "roomId": "String //设备安装空间 ID(取的是门禁的)",
    "positionPath": "String //设备安装位置(取的是门禁的)",
    "deviceMac": "String //设备 MAC 地址",
    "ipAddress": "String //设备 IP 地址",
    "cid": "String //设备 cid,S/N",
    "deviceSn": "String //序列号",
    "deviceStatus": "int //设备在线状态",
    "firstOnlineTime": "long //首次上线时间",
    "lastOnlineTime": "long //上次在线时间",
    "deviceSourceType": "String //来源类型 1-非标准协议(luwu_device_bind),2-标准协议(luwu_smart_device)",
    "accessControlType": "int //门禁类型(1:单元门禁,2:大门门禁,3:门禁一体机,4:人行通道控制器,5:智能锁)",
    "gateway": "String //接入网关(智能锁专用)"
  },
  "accessControlChannelVOList": [
    {
      "projectId": "String //项目 ID",
      "accessControlId": "String //门禁 ID",
      "accessControlChannelId": "String //门禁出入口 ID",
      "accessControlChannelName": "String //门禁出入口名称",
      "accessControlChannelNo": "String //通道号",
      "roomId": "String //门禁出入口安装空间 ID",
      "positionPath": "String //门禁出入口安装位置",
      "readerVOList": [
        {
          "projectId": "String //项目 ID",
          "accessControlId": "String //门禁 ID",
          "accessControlChannelId": "String //门禁出入口 ID",
          "accessControlReaderId": "String //读头 ID",
          "readerName": "String //读头名称",
          "readerType": "String //读头类型,self-自身,button-开门按钮",
          "readerDirection": "int //读头标识,0-进,1-出",
          "readerModel": "String //读头型号",
          "readerFactory": "String //读头厂家",
          "roomId": "String //门禁出入口安装空间 ID",
          "positionPath": "String //门禁出入口安装位置"
        }
      ]
    }
  ]
}

请求示例

{
    "projectId":"1424615984265764***",
    "accessControlId":"1567349953007718***"
}

响应示例

{
    "result": {
        "access_control_channel_v_o_list": [
            {
                "access_control_channel_id": "1567458975220301***",
                "access_control_channel_name": "测 1",
                "access_control_channel_no": "1",
                "access_control_id": "1567349953007718***",
                "position_path": "中心-11",
                "project_id": "1424615984265764***",
                "reader_v_o_list": [
                    {
                        "access_control_channel_id": "1567458975220301***",
                        "access_control_reader_id": "1567460228306370***",
                        "position_path": "中心-11",
                        "project_id": "1424615984265764***",
                        "reader_direction": 0,
                        "reader_factory": "制造商 B",
                        "reader_model": "12345",
                        "reader_name": "测试读头",
                        "reader_no": 1,
                        "reader_type": "self",
                        "room_id": "1424637349790294***"
                    },
                    {
                        "access_control_id": "1567349953007718***",
                        "project_id": "1424615984265764***",
                        "reader_no": 2
                    }
                ],
                "room_id": "1424637349790294***"
            }
        ],
        "access_control_device_v_o": {
            "access_control_id": "1567349953007718***",
            "access_control_type": 4,
            "cid": "",
            "device_id": "6c04c99318f080ffc8p***",
            "device_mac": "0005",
            "device_name": "智能门锁(Lora) 3",
            "device_sn": "",
            "device_source_type": "2",
            "device_status": 1,
            "first_online_time": 1659431459133,
            "ip_address": "",
            "last_online_time": 1662535418079,
            "position_path": "修改 111",
            "project_id": "1424615984265764***",
            "room_id": "1428256638111883***"
        },
        "access_control_id": "1567349953007718***"
    },
    "success": true,
    "t": 1662712140222,
    "tid": "73fe101b301911edaf4dfa23c521f7ba"
}

获取门禁列表

功能描述

获取门禁列表。

接口地址

GET /v1.0/iot-02/building/access-controls

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlName String body 门禁名称(门禁设备名称)
ipAddress String body IP 地址
deviceMac String body 设备 Mac 地址
cid String body 设备 cid S/N
deviceSn String body 序列号
deviceStatus String body 设备状态(0-离线,1-在线)
accessControlType String body 门禁类型
accessControlModel String body 门禁型号
accessControlFactory String body 门禁厂家
deviceName String body 门禁控制器/设备名称
accessControlChannelName String body 出入口名称
readerName String body 读头名称
readerType String body 读头类型,self:自身,button:开门按钮。数据字典获取
readerModel String body 读头型号
readerFactory String body 读头厂家
roomId String body 区域 ID
containSub boolean body 包含下级区域
page Integer body 页数
pageSize Integer body 页大小

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "projectId": "String //项目 ID",
      "accessControlId": "String //门禁 ID",
      "deviceId": "String //设备 ID",
      "accessControlName": "String //门禁名称",
      "accessControlType": "int //门禁类型",
      "accessControlModel": "String //门禁型号",
      "accessControlFactory": "String //门禁厂家",
      "roomId": "String //门禁安装空间 ID",
      "positionPath": "String //门禁安装位置",
      "deviceStatus": "int //设备状态",
      "deviceName": "String //设备名称",
      "deviceMac": "String //设备 MAC 地址",
      "ipAddress": "String //设备 IP 地址",
      "cid": "String //设备 cid,S/N",
      "deviceSn": "String //序列号"
    }
  ]
}

请求示例

{
    "page":1,
    "pageSize":10,
    "roomId":"1424637349790294***",
    "containSub":false,
    "projectId":"1424615984265764***"
}

响应示例

{
    "result": {
        "list": [
            {
                "access_control_factory": "111",
                "access_control_id": "1567497898814345***",
                "access_control_model": "型号 A",
                "access_control_name": "测试 2",
                "access_control_type": 4,
                "cid": "",
                "device_id": "6c1df351604c61044en***",
                "device_mac": "",
                "device_sn": "",
                "device_status": 1,
                "ip_address": "118.25.183.11",
                "position_path": "中心-11",
                "project_id": "1424615984265764***",
                "room_id": "1424637349790294***"
            }
        ],
        "total": 30
    },
    "success": true,
    "t": 1662712328349,
    "tid": "e460b0ed301911edaf4dfa23c521f7ba"
}

获取门禁详情

功能描述

获取门禁详情。

接口地址

GET /v1.0/iot-02/building/access-controls/{access_control_id}

请求参数

参数名 类型 参数类型 说明 是否必需
accessControlId String body 门禁 ID
projectId String body 项目 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "projectId": "String //项目 ID",
  "accessControlId": "String //门禁 ID",
  "accessControlName": "String //门禁名称",
  "accessControlType": "int //门禁类型",
  "accessControlModel": "String //门禁型号",
  "accessControlFactory": "String //门禁厂家",
  "roomId": "String //门禁安装空间 ID",
  "positionPath": "String //门禁安装位置",
  "accessControlDeviceVO": {
    "projectId": "String //项目 ID",
    "accessControlId": "String //门禁 ID",
    "deviceId": "String //设备 ID",
    "deviceName": "String //设备名称",
    "roomId": "String //设备安装空间 ID(取的是门禁的)",
    "positionPath": "String //设备安装位置(取的是门禁的)",
    "deviceMac": "String //设备 MAC 地址",
    "ipAddress": "String //设备 IP 地址",
    "cid": "String //设备 cid,S/N",
    "deviceSn": "String //序列号",
    "deviceStatus": "int //设备在线状态",
    "firstOnlineTime": "long //首次上线时间",
    "lastOnlineTime": "long //上次在线时间",
    "deviceSourceType": "String //来源类型 1-非标准协议(luwu_device_bind),2-标准协议(luwu_smart_device)",
    "accessControlType": "int //门禁类型(1:单元门禁,2:大门门禁,3:门禁一体机,4:人行通道控制器,5:智能锁)",
    "gateway": "String //接入网关(智能锁专用)"
  }
}

请求示例

{
  "accessControlId": "门禁 ID",
  "projectId": "项目 ID"
}

响应示例

{
    "result": {
        "access_control_device_v_o": {
            "access_control_id": "1567349953007718***",
            "cid": "",
            "device_id": "6c04c99318f080ffc8p***",
            "device_mac": "0005",
            "device_name": "智能门锁(Lora) 3",
            "device_sn": "",
            "device_source_type": "2",
            "device_status": 1,
            "first_online_time": 1659431459133,
            "ip_address": "",
            "last_online_time": 1662535418079,
            "project_id": "1424615984265764***"
        },
        "access_control_factory": "制造商 B",
        "access_control_id": "1567349953007718***",
        "access_control_model": "12345",
        "access_control_name": "测试修改",
        "access_control_type": 4,
        "position_path": "修改 111",
        "project_id": "1424615984265764***",
        "room_id": "1428256638111883***"
    },
    "success": true,
    "t": 1662712393558,
    "tid": "0b4412ec301a11edaf4dfa23c521f7ba"
}

获取未绑定的门禁设备列表

功能描述

获取未绑定的门禁设备列表。

接口地址

GET /v1.0/iot-02/building/access-control-devices

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
deviceSourceType String body 设备来源类型
deviceName String body 设备名称
deviceMac String body MAC 地址
cid String body 设备 cid,S/N
deviceSn String body 序列号
ipAddress String body 设备 IP 地址
page Integer body 页数
pageSize Integer body 页大小

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "projectId": "String //项目 ID",
      "accessControlId": "String //门禁 ID",
      "deviceId": "String //设备 ID",
      "deviceName": "String //设备名称",
      "roomId": "String //设备安装空间 ID(取的是门禁的)",
      "positionPath": "String //设备安装位置(取的是门禁的)",
      "deviceMac": "String //设备 MAC 地址",
      "ipAddress": "String //设备 IP 地址",
      "cid": "String //设备 cid,S/N",
      "deviceSn": "String //序列号",
      "deviceStatus": "int //设备在线状态",
      "firstOnlineTime": "long //首次上线时间",
      "lastOnlineTime": "long //上次在线时间",
      "deviceSourceType": "String //来源类型 1-非标准协议(luwu_device_bind),2-标准协议(luwu_smart_device)",
      "accessControlType": "int //门禁类型(1:单元门禁,2:大门门禁,3:门禁一体机,4:人行通道控制器,5:智能锁)",
      "gateway": "String //接入网关(智能锁专用)"
    }
  ]
}

请求示例

{
  "ipAddress": "设备 IP 地址",
  "deviceMac": "MAC 地址",
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID",
  "deviceName": "设备名称",
  "deviceSn": "序列号",
  "deviceSourceType": "设备来源类型",
  "cid": "设备 cid,S/N"
}

响应示例

{
  "total": "int",
  "list": [
    {
      "list": "接入网关(智能锁专用)"
    }
  ]
}

错误码

以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

错误码 说明
500 系统错误