人脸门禁服务API

更新时间：2020-07-02 18:19:03

人脸门禁服务解决方案

人脸门禁边缘解决方案>>
边缘模式 / 设备直连云 API

人脸门禁服务概述

人脸门禁服务是一套为企业提供的支持人脸图片管理与人脸权限管理的服务。企业可以基于人脸门禁服务，结合阿里云IoT平台的空间管理功能，快速实现自己的SaaS平台。人脸门禁服务的云端API同时兼容边缘方案与端侧方案。

接口分为三部分：

人脸图片管理

人脸权限管理

订阅关系管理

接口定义

人脸图片管理

保存人脸图片

保存单个用户的人脸图片，支持不同用户体系（详见入参），图片以URL或base64编码的格式传入，宽、高不超过800像素，文件大小不超过1MB。

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userId":"xxx",
  "imageUrl":"http://yyy/1.jpg"
}

出参示例

{
    "code": 200,
    "message": "success"
}

删除人脸图片

删除单个用户的人脸图片，支持不同用户体系（详见入参）。

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userId":"xxx"
}

出参示例

{
    "code": 200,
    "message": "success"
}

获取人脸图片

根据用户id和用户类型查询人脸图片，返回的图片格式支持URL和base64编码。

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userId":"xxx",
  "imageFormat":"URL"
}

出参示例

{
    "code": 200,
    "data": {
    "imageUrl":"http://yyy/1.jpg"
    },
    "message": "success"
}

人脸权限管理

增加人脸权限

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

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userIdList":
  [
    "xxx"
  ],
  "scopeType":"IOT_ID",
  "scopeIdList":
  [
    "zzz"
  ]
}

出参示例

{
    "code": 200,
    "message": "success"
}

删除人脸权限

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

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userIdList":
  [
    "xxx"
  ],
  "scopeType":"IOT_ID",
  "scopeIdList":
  [
    "zzz"
  ]
}

出参示例

{
    "code": 200,
    "message": "success"
}

查询用户的权限状态

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

入参

出参

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

示例

入参示例

{
  "userType":"OPEN",
  "userId":"xxx"
}

出参示例

{
    "code": 200,
    "data": {
    "userType":"OPEN",
    "userId":"xxx",
    deviceListTotal:1,
    deviceListPageNo:1,
    deviceListPageSize:20,
    deviceList:
    [
      "iotId":"zzz",
      "syncTime":"2019-02-28 19:00:00",
      "syncStatus":"transferred"
    ]
    },
    "message": "success"
}

查询设备的权限状态

查询下发到某个设备的人脸图片列表（含下发状态）。

入参

出参

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

示例

入参示例

{
  "iotId":"zzz"
}

出参示例

{
    "code": 200,
    "data": {
    "total":1,
    "pageNo":1,
    "pageSize":20,
    "userList":
    [
      {
            "userType":"OPEN",
            "userId":"xxx",
          "syncTime":"2019-02-28 19:00:00",
          "syncStatus":"transferred"
      }
    ]
    },
    "message": "success"
}

查询空间的权限状态

查询下发到某个空间的人脸图片列表（含下发状态）。

入参

出参

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

示例

入参示例

{
  "spaceId":"aaa"
}

出参示例

{
    "code": 200,
    "data": {
    "total":1,
    "pageNo":1,
    "pageSize":20,
    "userList":
    [
      {
            "userType":"OPEN",
            "userId":"xxx",
        "deviceCount":1,
        "successCount:"1
      }
    ]
    },
    "message": "success"
}

人脸门禁通行事件

人脸门禁通行数据模型

订阅关系管理（推荐使用数据模型定义）

增加设备消息推送订阅

当存在跨租户给设备授权的时候，被授权租户想接收设备上报的事件，需要调用这个接口来做授权

入参

出参

ModifyResultDTO定义

示例

入参示例

{
    "iotIds":[
        "p2OsgId2N2kXMWThRCQP000101"
    ],
   "subscribed": 1
}

出参示例

{
    "code": 200,
    "id": "4a70179d-47d8-4fdf-9067-8a5eedf63483",
    "message": null,
    "localizedMsg": null
}

查询订阅消息推送设备列表

查询已经订阅消息的设备列表，包括已经取消了订阅的设备

入参

出参

分页数据对象PageDTO

UserDTO对象

示例

入参示例

{
  "pageSize":10,
  "pageNo":1
}

出参示例

{
    "code": 200,
    "data": {
        "total": 1,
        "data": [{
            "bizCode": "bizTypeTest",
            "categoryKey": "categoryKeyTest",
            "deviceName": "deviceNameTest",
            "gmtCreate": 1556517249000,
            "gmtModified": 1556517249000,
            "iotId": "iotTest",
            "productKey": "productKeyTest",
            "subscribed": 1,
            "tenantId": "tenantTest"
        }]
    },
    "id": "4a70179d-47d8-4fdf-9067-8a5eedf63483",
    "message": null,
    "localizedMsg": null
}

删除设备消息推送订阅

删除订阅关系

入参

出参

示例

入参示例

{
    "iotIds":[
        "p2OsgId2N2kXMWThRCQP000101"
    ]
}

出参示例

{
    "code": 200,
    "id": "4a70179d-47d8-4fdf-9067-8a5eedf63483",
    "message": null,
    "localizedMsg": null
}