人脸门禁边缘网关接入API

更新时间：2019-08-29 20:36:46

人脸门禁服务边缘解决方案使用手册

人脸门禁边缘解决方案>>

一、方案架构及功能

image.png

二、通信协议

2.1 要求

  • 通信协议基于HTTP，边缘服务器做HTTP Server，门禁机支持配置连接服务器的IP地址和端口号

  • 剪切的图片中包含人脸，比人脸要稍微大一些

  • 图片尺寸(宽、高)保证一致

    2.2 接口说明

    2.2.1 连接

  • 相对url: /connect

  • method: POST

  • Content-Type：application/json

  • 描述： 门禁机向边缘网关建立连接，同步设备信息

  • 参数：

参数 类型 说明 备注
sn string 设备sn N/A
time int utc时间戳 例如：1502175700
ip string ipv4 地址 N/A
mac string mac地址
version string 格式：xx.xx.xx N/A
keepalive int 保活超时时间 单位：s
signMethod string 签名算法 目前支持的有： md5/sha1/sha256
sign string 签名后的内容 需要签名的内容封装格式："TIME{time}MAC{mac}SN{sn}IP{ip}"

大括号内的是具体内容，其外面的是名称。备注：time要转换成string类型 |

  • 返回值：
    {
  "code": 0,
  "message": "success",
  "data":{
      "token": "xxxx"
  }
}

参数说明：

参数 类型 说明 备注
code int 查看错误码表
message string



data		 token string 连接成功后，Edge会颁发身份标示信息，在后续的“心跳包活”、“人脸请求”时需要携带。

2.2.2 心跳保活

  • 相对ulr: /keepalive

  • method: POST

  • Content-Type：application/json

  • 描述：

  • 参数：

参数 类型 说明 备注
token string 设备的标识信息 在建立连接时，由边缘网关下发，在规定的时间内未收到心跳，则token失效。
  • 返回值：
    {
  "code": 0,
  "message": "success"
}

2.2.3 人脸识别请求

  • 相对url: /recognize

  • method: POST

  • Content-Type：multipart/form-data

  • 描述： 携带人像身份信息

  • 参数:

参数 类型 说明 备注
token string 设备的标识信息 在建立连接时，由边缘网关下发，在规定的时间内未收到心跳，则token失效。
photo file 照片文件 质量校验通过人像照片
  • 返回值：
    {
  "code": 0,
  "message": "success",
  "data":{
      "faceId": "xxxx",
      "name": "xxx",
      "photoId": "xxx"
  }
}

参数说明

参数 类型 说明 备注
code int 查看错误码表
message string



data		 faceId string 人脸id
name string 识别人员姓名
photoId string 底库照片ID 3秒会失效

2.2.4 获取底库照片

  • 相对url: /staticPhoto

  • method: GET

  • Content-Type：

  • 描述： 获取底库照片

  • 参数

参数 类型 说明 备注
token string 设备的标识信息 在建立连接时，由边缘网关下发，在规定的时间内未收到心跳，则token失效。
photoId string 底库照片ID
  • 返回值

http code：200-成功、404-不可用或者失效

2.2.5 二维码识别请求

  • 相对url: /qrcode

  • method: POST

  • Content-Type：application/json

  • 描述： 携带二维码字符串

  • 参数:

参数 类型 说明 备注
token string 设备的标识信息 在建立连接时，由边缘网关下发，在规定的时间内未收到心跳，则token失效。
qrCode string 二维码
  • 返回值：
    {
  "code": 0,
  "message": "success",
}

参数说明

参数 类型 说明 备注
code int 查看错误码表
message string

错误码表

错误码 说明
0 成功
1 未匹配
2 请求忙
3 接近匹配，需要重试
4 token无效
5 请求参数无效或非法
6 验签失败
7 设备非法，部署时会将所有门禁设备的IP地址添加到白名单中，若发现为非法设备，则提示“设备非法”
99 未知错误

三、发布历史

v1.0.0 2019-08-30

  • 人脸门禁边缘网关接入API初始版本。

  • 支持门禁机人脸和二维码两种API对接。

results matching ""

    No results matching ""