人脸通行

更新时间：2018-12-29 16:33:50

公共字段

以下参数通过登录信息中提取，不需要每次调用的时候传递

参数名称 参数
用户ID identityId
租户ID tenantId
登录用户租户ID identityTenantId
appKey appKey
资源隔离ID isolationId
环境（开发，线上） env
调用方Ip clientIp
语言 language
地理位置、ip locale
通过智慧人居服务以下两个接口获取：* 房屋列表：/homelink/house/list


* 房屋详情：/homelink/house/detail/get

| scopeId |

人脸通行服务

1. 保存人脸

1.1. 定义描述

path 版本 描述 是否需要登录
/campuslink/face/save 1.0.0 保存人脸图片，如果已存在人脸图片则覆盖更新 是

1.2. 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 是 园区ID，也就是rootSpaceId
scopeType String 是 SPACE_ID或PROJECT_ID
userId String 否 家人用户Id，添加家人用户的人脸照片时必填
imageBase64 String 否 跟imageUrl二选一，优先用imageUrl，业主人脸图片的BASE64编码信息，图片大小不能超过2M
imageUrl String 否 跟imageBase64二选一，优先用imageUrl，图片大小不能超过2M
faceTag String 是 用于标识人脸的运用场景，分为： 
 * CAMPUS,    //园区类型
 * COMMUNITY, //人居类型

默认为COMMUNITY |

1.3. 返回参数

1.4. 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "scopeId": "aaaaaaaaaaaaaaaaaaa67bf5279cdc9976",
        "userId": "vvvvvvvvvvvvvvvvA3BD78D7963D439B67",
        "imageBase64": "/9j/4AAQSkZ"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success"
}

错误码：

错误码 错误信息 描述
16101 face picture unqualified 注册人脸不合格（错误描述是具体的）
16104 can not find this face 人脸ID找不到
2000 无效的虚拟用户id
2001 没有对应的人脸识别闸机设备
999 未知错误

2. 获取人脸

2.1. 定义描述

path 版本 描述 是否需要登录
/campuslink/face/fetch 1.0.0 获取人脸图片 是

2.2. 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 是 园区ID，也就是rootSpaceId
scopeType String 是 SPACE_ID或PROJECT_ID
userId String 否 家人用户Id，获取业主亲属人脸时必填
urlFormat bool 否 默认为false，需要返回url的时候设置为true

2.3. 返回参数

参数名 类型 说明
imageBase64 String 业主人脸图片的BASE64编码信息
imageUrl String urlFormat为true的时候返回图片的url地址

2.4. 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "scopeId": "aaaaaaaaaaaa4bfa867bf5279cdc9976",
        "userId": "vvvvvvvvvvvvv649A3BD78D7963D439B67"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success",
    "data":"/9j/4AAQSkZJR"
}

错误码：

错误码 错误信息 描述
16102 not this record 解绑人脸的时候发现不存在这条记录
16104 can not find this face 人脸ID找不到
16105 can not find this group 人脸分组ID找不到
601 数据不存在

3. 删除人脸

3.1. 定义描述

path 版本 描述 是否需要登录
/campuslink/face/delete 1.0.0 删除人脸图片 是

3.2. 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 是 园区ID，也就是rootSpaceId
scopeType String 是 SPACE_ID或PROJECT_ID
userId String 否 家人用户Id，删除业主亲属人脸时必填

3.3. 返回参数

参数名 类型 说明
imageBase64 String 业主人脸图片的BASE64编码信息

3.4. 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0"

,
        "iotToken": "token"
    },
    "params": {
        "scopeId": "aaaaaaaaaaaaaabfa867bf5279cdc9976",
        "userId": "vvaaaaaaaaaaaa49A3BD78D7963D439B67"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success"
}

错误码：

错误码 错误信息 描述
16102 not this record 解绑人脸的时候发现不存在这条记录
16104 can not find this face 人脸ID找不到
16105 can not find this group 人脸分组ID找不到
601 数据不存在

4. 查询照片下发状态

4.1. 定义描述

path 版本 描述 是否需要登录
/campuslink/face/queryDeviceStatus 1.0.0 查询照片下发到设备的状态 是

3.2. 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 是 园区ID，也就是rootSpaceId
scopeType String 是 SPACE_ID或PROJECT_ID
userId String 否 虚拟用户身份，删除业主亲属人脸时必填

3.3. 返回参数

FaceStatusDTO

参数名 类型 说明
code int 200 下发成功

201 下发中
202 设备离线
203 图片不合格 |
| description | String | |

3.4. 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0"

,
        "iotToken": "token"
    },
    "params": {
        "scopeId": "aaaaaaaaaaaa4bfa867bf5279cdc9976",
        "userId": "vvvvvvvvvvvv649A3BD78D7963D439B67"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success"
}

错误码：

错误码 错误信息 描述
16102 not this record 解绑人脸的时候发现不存在这条记录
16104 can not find this face 人脸ID找不到
16105 can not find this group 人脸分组ID找不到
601 数据不存在

results matching ""

    No results matching ""