云智易的管理后台接口

API列表

编号 API名称 路径 版本
1.1 统一人脸接口 /v2/smart-access/{projectId}/face-device/reload 1.0
1.2 人脸门禁授权日志接口 /v2/smart-access/{projectId}/face-recognition/authorization/log 1.0
1.3 人脸梯控授权日志接口 /v1/xlink-lift-rest/face-device/elevator-authorization/log 1.0
2.1 代办访客列表 /v2/smart-access/agent/visitor/list/{flag} 1.0

API调用

1.1: 统一人脸接口

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v2/smart-access/{projectId}/face-device/reload

方法:POST

请求参数

名称 位置 类型 必填 描述
person_id body y 人员id
opt body y 操作: add 或者 remove
person_type body y 身份类型 1 住户 2访客 3员工 4其他
submitter_name body string y 名称
submitter_type body string string 提交人身份,和人脸素材的身份对应

请求Body描述(非Form表单数据)

{
"person_id":"46868474",
"opt":"add",
"person_type":"1",
"submitter_name": "谢尔额",
"submitter_type": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
door_auth_result body string y 授权结果
elevator_auth_result body string y 授权结guo
返回结果示例
{
    "status": 200,
    "msg": null,
    "data": {
        "door_auth_result": { "success_count":2,  "fail_count":3 },
        "elevator_auth_result": {"success_count":2,  "fail_count":3}
    },
    "code": null
}

API调用

1.2: 人脸门禁授权日志接口

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v2/smart-access/{projectId}/face-recognition/authorization/log

方法:POST

请求参数

名称 位置 类型 必填 描述
person_id body y 人员id

请求Body描述(非Form表单数据)

{
    "offset": 0,
    "limit": 10,
    "query": {
        "person_id": {
            "$eq": "46869051"
        }
    },
    "order": {
        "create_time": "desc"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
result body string y 授权结果
submitter_name body string y 授权结果
submitter_type body string y 授权结果
返回结果示例
{
    "status": 200,
    "msg": null,
    "data": {
        "count": 2,
        "list": [
            {
                "result": "success",
                "device_name": "A1区1栋门禁",
                "device_id": 452875497,
                "create_time": "2020-12-22T15:01:24.081Z",
                "project_id": "21441118",
                "open_time": "2020-12-22T15:01:24.081Z",
                "person_name": "2222测试166",
                "submitter_name": "老王",
                "id": "1645fe199c46e33494a789f4a4e",
                "submitter_type": 2,
                "person_id": "46869051"
            },
            {
                "result": "success",
                "device_name": "A1区1栋门禁",
                "device_id": 452875497,
                "create_time": "2020-12-22T14:56:27.194Z",
                "project_id": "21441118",
                "open_time": "2020-12-22T14:56:27.194Z",
                "person_name": "2222测试166",
                "submitter_name": "陆健华",
                "id": "1795fe1989b6e3349458852c752",
                "submitter_type": 5,
                "person_id": "46869051"
            }
        ]
    },
    "code": null
}

1.3: 人脸梯控授权日志接口

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/xlink-lift-rest/face-device/elevator-authorization/log

方法:POST

请求参数

名称 位置 类型 必填 描述
person_id body y 人员id

请求Body描述(非Form表单数据)

{
    "page": 1,
    "size": 10,
    "query": {
        "person_id": "46868893"
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
result body string y 授权结果
submitter_name body string y 授权结果
submitter_type body string y 授权结果
返回结果示例
{
    "status": 200,
    "msg": null,
    "data": {
        "count": 2,
        "list": [
            {
                "result": "success",
                "device_name": "A1区1栋门禁",
                "device_id": 452875497,
                "create_time": "2020-12-22T15:01:24.081Z",
                "project_id": "21441118",
                "open_time": "2020-12-22T15:01:24.081Z",
                "person_name": "2222测试166",
                "submitter_name": "老王",
                "id": "1645fe199c46e33494a789f4a4e",
                "submitter_type": 2,
                "person_id": "46869051"
            },
            {
                "result": "success",
                "device_name": "A1区1栋门禁",
                "device_id": 452875497,
                "create_time": "2020-12-22T14:56:27.194Z",
                "project_id": "21441118",
                "open_time": "2020-12-22T14:56:27.194Z",
                "person_name": "2222测试166",
                "submitter_name": "陆健华",
                "id": "1795fe1989b6e3349458852c752",
                "submitter_type": 5,
                "person_id": "46869051"
            }
        ]
    },
    "code": null
}

2.1: 代办访客列表

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v2/smart-access/agent/visitor/list/{flag}

方法:POST

请求参数

名称 位置 类型 必填 描述
flag body y 1代表查询访客 2代表查询特殊访客
body body y 原参数不变

请求Body描述(非Form表单数据)

{"offset":0,"limit":10,"query":{      },"order":{"create_time":"desc"}   }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
返回结果示例
{
    "status": 200,
    "msg": null,
    "data": {
        "count": 1330,
        "list": []
    },
    "code": null
}

results matching ""

    No results matching ""