人脸识别

    软件说明文档

    功能

    1. 人脸注册

      动态人脸采集--活体检测--特征提取--人脸和特征值入库

    2. 人脸库管理

      1. 人脸库统计
      2. 查询人脸库记录
      3. 删除特定人脸底库
      4. 清空人脸库
    3. 设备管理

      1. WLAN管理,包括wifi列表查询、热点连接/断开
      2. LAN管理,包括自动IP设置、手动IP设置
    4. IPC Web网页控制

      1. 视频流预览,包括主码流(RGB)、辅码流(IR)、图像抓拍、实时录像
      2. 设置

        • 视频设置,包括视频质量参数、视频编码、图片参数、字符叠加等
        • 网络设置,包括有线网络参数设置、无线网络参数设置、RTSP参数等
        • 智能分析--门禁控制,包括补光灯控制、LCD屏保控制、开机默认识别模式、流程质量控制(端上视频流人脸注册)、图片质量控制(图片人脸注册)
    5. 闸机模式

      人脸检测--活体检测--特征提取--1:N特征比对(识别)--结果展示(显示+声音)--闸机控制--http上传识别记录

    6. 考勤模式

      人脸检测--活体检测--特征提取--1:N特征比对(识别)--签到--http上传识别记录

    7. 金融核验模式

      人脸检测--活体检测--面部姿态判断--面部遮挡判断--1:1特征比对(证件照)--核验成功--人脸信息结果上报

    具体参数

    名称 功能描述
    操作系统 Linux
    图像分辨率 支持1080p、720p图像
    显示 支持5寸、7寸、8寸屏显示
    模态 支持RGB和NIR模态并行采集、检测
    活体检测 支持RGB和NIR活体,能抵抗99.99%的攻击
    人脸检测速度 25fps
    人脸识别性能 150ms内完成端到端人脸识别
    检索 支持1:1和1:N的人脸检索,检索速度小于20ms(默认5W)
    人脸库管理 最大支持10W的人脸底库的管理,支持人脸底库批量导入,增加,删除,查询
    网络 支持RTSP网络视频流、支持HTTP标准网络协议
    web 内嵌webserver,支持通过WebServer登录

    操作说明

    接通电源

    度目人脸应用套件可使用12V电源适配器独立供电,或者POE网线供电,用户可根据需求自行选择

    接通电源后,系统进入开机画面,开始初始化,这个过程时间较长(大约30s),需要加载AI算法和人脸库,人脸库规模越大,时间越长,用户请耐心等待

    系统初始化完毕,进入开机默认界面,该界面展示了度目人脸应用套件的所有功能:设备管理闸机模式考勤模式金融核验模式人脸注册人脸库管理

    初始化后的默认界面可通过web页面或者http协议设置,设置方法参考web页面设置API

    设备管理

    点击图上图中,右上角img设置按钮,进入设备管理界面,该界面具备3种设备设置能力:

    • WiFi设置,点击wifi列表中的相应热点名,可进行WLAN wifi热点列表展示、热点连接
    • 有线网络设置,可进行LAN相关设置,包括手动获取IP、自动获取IP,IP地址、子网掩码、网关和DNS

    设备管理同样可以在web页面和http协议中进行设置,参考web页面设置API

    人脸注册

    在开机默认界面,点击人脸注册按钮,进入人脸注册界面,请根据界面提示,将人脸放置于圆圈内,当人脸四周出现红色框时,表示人脸质量不符合要求,请适当调整面部姿态、距离,直到红色框变成绿色,若长时间未检测到绿色框,系统会给出提示,并且要求用户选择是否继续注册人脸

    当人脸质量符合要求时(绿色人脸框),界面中心圆圈将开始顺时针旋转,请注意保持姿势不变,待旋转一圈时,完成人脸注册,输入注册用户名

    人脸库管理

    在开机默认界面,点击人脸库管理按钮,进入人脸库管理界面,该界面展示了已注册人脸信息,最下方显示总数以及“清空数据库”按钮,点击该按钮可一键清除所有人脸库,也可以选中某个人脸信息,点击右侧出现的“删除”按钮

    闸机模式

    在开机默认界面,点击闸机模式按钮,进入闸机模式界面(如下图左图),该模式下系统实时检测人脸、活体检测、特征提取、1:N比对识别,识别成功会由声音、画面提示,如果连接闸机端子,同时还会输出控制信号。系统可同时检测多张人脸,但只有显示绿色框的人脸被送去做活检和识别。

    考勤模式

    在开机默认界面,点击考勤模式按钮,进入考勤模式界面(如下图左图),该界面下显示当前时间,当有人脸被检测到,并完成活体检测、特征提取、1:N识别成功后,记录签到时间,并通过http协议上传到控制中心(控制中心需要单独开发),协议请参考API

    金融核验模式

    在开机默认界面,点击金融核验模式按钮,进入金融核验模式界面,该模式专门为金融核验场景设计,它对注册环节采取更严格的条件限制,确保确保采集人脸质量、角度、遮挡、活体等条件均满足金融场景要求,当前该模式的使用方式类似人脸注册

    web页面设置

    准备一台windows电脑,将电脑和套件接入同一局域网内,并确保电脑与套件在同一网段内,例如:套件默认IP地址是192.168.1.88,则电脑可将IP地址设置为192.168.1.100,打开IE浏览器,在网址处输入192.168.1.88,则登录套件的web页面,首次登录会强制设置用户名和密码

    用户名:admin,密码:123456

    • 网络设置

      • 有线网络参数,可以进行IP的相关测试修改,例如:IP、子网掩码、网关等
      • 无线网络配置,可以进行搜索到无线网络进行连接

    • 音频属性

    音频属性,设置输出音量控制(0~15),喇叭的声音大小

    • 智能分析

    人脸识别门禁控制

    1. 灯光亮度:0~10s
    2. 屏保开关:开/关(设置完必须重启生效)
    3. 触发屏保时间:0~60s(设置完必须重启生效)
    4. 识别模式:(设置完必须重启生效)

    5. 流程质量控制:

      该设置项用于选择某个流程(环节),与“图片质量控制”相结合,共同确定一个质量控制等级,该设置项包括3类流程(环节),参考HTTP协议设置章节:

      • 全流程:设置所有流程(环节),包括图片注册流程+活体检测识别流程
      • 图片注册流程:仅设置图片注册流程(环节)
      • 识别流程:仅设置识别流程(环节)
    6. 图片质量控制:

      该设置项对图片的质量等级进行设置,主要有4个等级,参考API

      • 不控制:不对图片质量进行判断,低质量图片也会被允许
      • 较低:对图片提出较低的质量要求,例如:遮挡0.8、角度30°、光照不要求、模糊度 0.8等
      • 一般:对图片提出一般的质量要求,例如:遮挡0.6、角度20°、光照在40-255、模糊度 0.6
      • 较高:对图片提出较高的质量要求,例如:遮挡0.3、角度15°、光照在60-120、模糊度 0.3

    API

    http协议是帮助用户解决远程配置度目人脸应用套件参数、远程获取套件信息等问题而设计的通信协议,度目人脸应用套件的http协议分为两大类:设备侧http server部分设备侧http client部分,数据格式统一采用json字符串:

    • 设备侧http server:在设备端开启一个http server,数据传输方向为PC端--设备端
    • 设备侧http client:在PC端开启一个http server,数据传输方向为设备端--PC端

      • 识别记录回调
      • 设备心跳回调
      • 用户信息变更回调

    注:

    • 当设备作为http server时,数据传输只能在局域网内进行,当设备作为http client时,数据传输可以在局域网/公网内进行。
    • 除了“识别记录回调“、”设备心跳回调“、”用户信息变更回调“属于设备主动向PC发起数据外,其余协议部分均为PC主动向设备发起数据。

    协议概览

    http协议根据业务功能,划分为4种接口:设备管理接口用户管理接口识别管理接口记录管理接口

    http协议数据格式

    以无线网络(setWifNetwork)部分为例,PC向设备侧的http server发起post请求,设备的IP地址为192.168.1.88,端口号为8080,那么http通信的数据为:

    • PC向设备发送的数据,URL为http://192.168.1.88:8080/deviceManage/setWiFiNetwork

    数据内容:

    {
    
       “pass” : “xxxxxxxxx”,
    
        “DHCP” : “false”, // 手动IP模式
        
        “SSID” : “my wifi”, // wifi名称
        
        “PWD” : “xxxyyyzzz”, // wifi密码
        
        “IP” : “192.168.1.55”, // 将新的IP地址设置为192.168.1.55
        
        “gateway” : “192.168.1.1”,
        
        “subnet_mask” : “255.255.0.0”,
        
        “DNS” : “192.168.1.1”
    
    } 
    • 设备返回给PC的数据
    {
    
      "IP": "192.168.1.55",
    
      "gateway":  "192.168.1.1",
        
      "subnet_mask":  "255.255.0.0",
        
      "DNS":  "192.168.1.1",
        
      "SSID": "my wifi",
        
      "PWD": "xxxyyyzzz",
        
      "code":  true, // 执行成功
        
      "log":   "'setWiFiNetwork' success!" // 日志
    
    }

    手动IP设置成功后,设备会在5s内重启,设置生效。

    软件接口说明文档

    1. 接口流程说明

    • 客户购买套件
    • 在机器上配置密码
    • 进行密码的二次设置或复用
    • 导入人脸信息
    • 设置识别记录回调接口
    • 在设备上进行动态视频识别使用
    • 在上位机系统收集识别信息

    如设置需调整,通过接口进行配置修改

    如识别策略需调整,通过接口进行配置修改

    2. 接口参数设置

    • 接口根地址:http://设备IP地址:8080/
    • 接口形式:HTTP请求
    • 接口鉴权:每次请求需传入密码
    • 通用返回信息:

      • 是否调通,1成功,0失败
      • Boolean方式,成功为true,失败为false
      • 业务数据data,类型为数值、字符串或集合
      • msg:接口报错信息

    3. 接口详细内容

    注:设置完毕后,需要自动重启设备,重启后生效

    3.1 设备管理接口
    • 设备管理POST URL:http://设备IP:8080/deviceManage
    • 设备管理请求类型:

      序号 Request type 说明
      1 setPassword 密码管理
      2 getDeviceID 设备序列号获取
      3 setTime 设备时间
      4 Restart 设备重启
      5 reset 设备重置
      6 setWiredNetwork 有线网络
      7 setWiFiNetwork 无线网络
      8 setLogo 公司 LOGO
      9 setDisplayImg 屏保图片
      10 etBootupRegMethod 默认识别模式
      11 setPrompting 自定义提升信息
      12 setRecognitionCallback 识别记录回调
      13 setDeviceHeartBeat 设备心跳回调
      14 setUserCallback 用户信息变更回调
      15 getSoftVersion 获取软件版本

    1. 密码设置

    • 说明 设置及修改设备密码
    • 请求

      方法

      URL

      Request Type

      setPassword

      名称

      定义

      必须

      备注

      old_password

      设备旧密码

      Y

      设备新购或重置之后,需要进行密码设置,新旧密码传入一样的值即可。此接口的调用无需传入password

      其他大部分接口调用都需传入密码以鉴权

      密码请求需加密。

      new_password

      设备新密码

      Y

    • 返回

      • log信息
      • 新密码
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setPassword

      请求:

      {
      	"old_password":"123456",
      	"new_password":"654321"
      }

      返回:

      {
      	"new_password":	"654321",
      	"code":	true,
      	"log":	"'setPassword' success!"
      }

    2. 序列号获取

    • 说明

      获取设备的唯一出厂标识码。

    • 请求

      方法

      URL

      Request Type

      getDeviceID

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。(md5加密)

    注:序列号命名方式为 BD+设备标准串码,共计16位。

    • 返回

      • log信息
      • 设备序列号信息
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/getDeviceID

      请求:

      {
      
      "pass":"pass"
      
      }

      返回:

      {
      
      	"device_id":	"BD12345678901234",
      
      	"code":	true,
      
      	"log":	"'getDeviceID' success!"
      
      }

    3. 设备时间

    • 说明

      如设备在局域网内,可通过接口手动设置时间;如设备连接公网,可刷新自身时间默认为公网时间。

    • 请求

      方法

      URL

      Request Type

      setTime

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。(md5加密)

      timestamp

      Unix时间戳(秒)

      Y

      配置成功后,设备时间直接调整更新

    • 返回

      • log信息
      • 请求是否成功(请求成功后开始执行指令)
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setTime

      请求:

      {
      	"pass":"pass",
      	"timestamp":1577690264
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setTime' success!"
      }

    4. 设备重启

    • 说明

      用于强制重启设备。

    • 请求

      方法

      URL

      Request Type

      restart

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。,需加密请求。

    • 返回

      • log信息
      • 请求是否成功(请求成功后开始执行指令)
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/restart

      请求:

      {
      	"pass":"pass"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'restart' success!"
      }

    5. 设备重置

    • 说明

      所有功能配置恢复默认出厂值,数据并不受影响

    • 请求

      方法

      URL

      Request Type

      reset

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

    • 返回

      • log信息
      • 请求是否成功(请求成功后开始执行指令)
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/reset

      请求:

      {
      	"pass":"pass"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'restart' success!"
      }

    6. 有线网络

    • 说明

      用于管理有线网络情况下的配置,分为自动获取IP及手动配置两种模式,默认为自动配置。

    • 请求

      方法

      URL

      Request Type

      setWiredNetwork

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      DHCP

      自动获取IP

      Y

      truefalse,默认为true,自动获取IP,如果选择false,需要手动配置其余参数

      IP

      IP地址

      N

      手动模式配置成功后,设备5s内自动重启生效。接口配置的效果和在设备上手动配置效果相同,接口配置项可覆盖设备上手工配置。

      gateway

      网关

      N

      subnet_mask

      子网掩码

      N

      DNS

      DNS服务器

      N

    • 返回

      • log信息
      • 如为DHCP:显示配置模式是否成功
      • 如为手动IP配置:显示具体的配置信息
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setWiredNetwork

      请求:

      DHCP 关闭:
      {
      	"pass":"pass",
      	"DHCP": false,
      	"IP":"128.128.30.33",
      	"gateway":"128.128.1.1",
      	"subnet_mask":"255.255.0.0",
      	"DNS":"202.96.134.133"
      }
      DHCP 开启:
      {
      	"pass":"pass",
      	"DHCP": true
      }

      返回:

      DHCP 关闭:
      {
      	"IP":	"128.128.30.33",
      	"gateway":	"128.128.1.1",
      	"subnet_mask":	"255.255.0.0",
      	"DNS":	"202.96.134.133",
      	"code":	true,
      	"log":	"'setWiredNetwork' success!"
      }
      DHCP 开启:
      {
      	"DHCP":	true,
      	"code":	true,
      	"log":	"'setWiredNetwork' success!"
      }

    7. 无线网络

    • 说明

      设置WiFi,配置完成设备自动重启生效。

    • 请求

      方法

      URL

      Request Type

      setWiFiNetwork

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      DHCP

      自动获取IP

      Y

      truefalse,默认为true,自动获取IP,如果选择false,需要手动配置其余参数

      SSID

      WiFi地址

      Y

      只支持2.4G频段WiFi

      PWD

      WiFi密码

      Y

      不支持需要证书认证的WiFi

      IP

      IP地址

      N

      手动模式配置成功后,设备5s内自动重启生效。接口配置的效果和在设备上手动配置效果相同,接口配置项可覆盖设备上手工配置。

      gateway

      网关

      N

      subnet_mask

      子网掩码

      N

      DNS

      DNS服务器

      N

    • 返回

      • log信息
      • 如为DHCP:显示配置模式是否成功
      • 如为手动IP配置:显示具体的配置信息
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setWiFiNetwork

      请求:

      DHCP 关闭:
      {
      	"pass":"pass",
      	"DHCP": false,
      	"SSID": "SSID",
      	"PWD": "admin",
      	"IP":"128.128.30.133",
      	"gateway":"128.128.1.1",
      	"subnet_mask":"255.255.0.0",
      	"DNS":"202.96.134.133"
      }
      DHCP 开启:
      {
      	"pass":"pass",
      	"DHCP": true,
      	"SSID": "SSID",
      	"PWD": "admin"
      }

      返回:

      DHCP 关闭:
      {
      	"IP":	"128.128.30.133",
      	"gateway":	"128.128.1.1",
      	"subnet_mask":	"255.255.0.0",
      	"DNS":	"202.96.134.133",
      	"SSID": "SSID",
      	"PWD": "admin",
      	"code":	true,
      	"log":	"'setWiFiNetwork' success!"
      }
      	DHCP 开启:
      {
      	"DHCP":	true,
      	"SSID": "SSID",
      	"PWD": "admin",
      	"code":	true,
      	"log":	"'setWiFiNetwork' success!"
      }

    8. 公司LOGO

    • 说明

      用于替换在识别界面的所有logo位置的图形信息。

    • 请求

      方法

      URL

      Request Type

      setLogo

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      image_start

      开机logo图片,base64方式

      Y

      图片尺寸有固定要求

      (宽800*1280

      格式仅支持bmp格式

      如要恢复默认logo设置,可传入 -1

      image_top

      顶层logo图片,base64方式

      Y

      图片尺寸要求(宽160*64

      格式仅支持JPG

      如要恢复默认logo设置,可传入 -1

      top_text

      顶层文字

      Y

      长度不超过32Byte

    • 返回

      • log信息
      • 请求是否成功
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setLogo

      请求:

      {
      	"pass":"pass",
      	"image_start":"图片数据base64",
      	"image_top":"图片数据base64",
      	"top_text":"top_text"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setLogo' success!"
      }

    9. 屏保图片

    • 说明

      开机及待机情况下的屏保图片,是否开启,已经触发屏保的等待时间。

    • 请求

      方法

      URL

      Request Type

      setDisplayImg

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      is_open

      1:开启;0:关闭

      Y

       

      time

      单位:毫秒数

      Y

      10000,则在检测到人脸后的10000ms内,没有新的人脸被检测,则触发屏保

      images

      屏保图片,base64方式,大小小于5M。可传入多张图片,最多5张图片,并命名具体数字,如:

      1:图片的base64……

      2:图片的base64……

      Y

      具体图片的展示选择,以【屏保选择】接口设定生效为主。

    • 返回

      • log信息
      • is_open:返回open或close
      • time:触发的时间
    • JSON 格式

      URL:`http://设备IP:8080/deviceManage/setDisplayImg`

      请求:

      {
      	"pass":"pass",
      	"is_open": 0,
      	"time": 10000,
      	"images":{
      	 	"image1":"图片数据base64",
      		"image2":"图片数据base64",
      		"image3":"图片数据base64",
      		"image4":"图片数据base64",
      		"image5":"图片数据base64"
      	}
      }

      返回:

      {
      	"is_open": 0,
      	"time": 10000,
      	"code":	true,
      	"log":	"'setDisplayImg' success!"
      }

    10. 默认识别模式

    • 说明

      默认开机后,在设备上进入引导页,包含「门禁闸机」「考勤打卡」「金融核验」三个模式的入口。如设置默认开机模式,则直接跳过引导页,进入具体模式的识别界面。

    • 请求

      方法

      URL

      Request Type

      setBootupRegMethod

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      method

      开机默认进入什么模式

      Y

      Default:默认模式。进入引导页

      Gate:门禁闸机模式

      Attendance:考勤打卡模式

      Finance:金融核验模式

      下次主动重启设备后生效

    • 返回

      • log信息
      • 请求是否成功
      • 具体的模式名称
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setBootupRegMethod

      请求:

      {
      	"pass":"pass",
      	"method": "Default/Gate/Attendance/Finance"
      }

      返回:

      {
      	"method": "Default/Gate/Attendance/Finance",
      	"code":	true,
      	"log":	"'setBootupRegMethod' success!"
      }

    11. 自定义提示信息

    • 说明

      配置识别成功或失败时的文本和语音提示信息。

    • 请求

      方法

      URL

      Request Type

      setPrompting

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      success_word

      识别成功欢迎语

      Y

      支持中文、数字、和英文,不支持符号,长度20个字符以内。

      支持欢迎语-{name}方式,{name}取自用户信息的名字字段,如传入「1」,则开启此模式,默认不包含名字信息

      fail_word

      识别失败提示语

      Y

      支持中文、数字、和英文,不支持符号,长度20个字符以内。

      success_audio

      识别成功的提示音

      N

      AACWAV格式,1M以内。系统含默认提示音,如用户上传音频文件,则优先使用覆盖后的音频文件。如恢复出厂设置后,提示音恢复为默认,暂时不支持此项。

      fail_audio

      识别失败的提示音

      N

      audio

      是否开启提示音

      N

      提示音开关

      profile_photo

      是否开启头像显示模式,默认不开启,如不开启则仅显示文字信息;如开启,则文字和头像都显示

      N

      显示的头像信息并非注册照片,而是当前用于识别的图片

    • 返回

      • log信息
      • 请求是否成功
      • 具体的话术设置信息
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setPrompting

      请求:

      {
      	"pass": "pass",
      	"success_word": "success_word",
      	"fail_word": "fail_word",
      	"success_audio": "success_audio_file.base64",
      	"fail_audio":"fail_audio_file.base64",
      	"audio": true,
      	"profile_photo": true
      }

      返回:

      {
      	"success_word": "success_word",
      	"fail_word": "fail_word",
      	"audio": true,
      	"profile_photo": true,
      	"code":	true,
      	"log":	"'setPrompting' success!"
      }

    12. 识别记录回调

    • 说明

      设置识别回调接口后,识别后,设备会向回调地址POST一条识别记录。

      注:如果设置了识别间隔时间,在识别间隔时间内,只会回调一条记录。

    • 请求

      方法

      URL

      Request Type

      setRecognitionCallback

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      callback_url

      回调地址

      Y

      详见下方回调信息

      interval_time

      回调重试时间段

      N

      对于回调失败的记录,每隔多长时间,整体重试一次请求

    • 回调信息

      • log信息
      • 回调成功(反馈给设备),标记此次记录的status为1

        • IP:设备所在IP
        • device_id:设备序列号
        • timestamp:时间戳
        • user_id:用户id
        • score:识别分数
        • image:用于识别的图片原图,base64方式
      • 回调失败(反馈给设备),记录存于设备本地,标记此次记录的status为0
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setRecognitionCallback

      请求:

      {
      	"pass": "pass",
      	"callback_url": "http://128.128.30.39:8011/face",
      	"interval_time": 60
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setRecognitionCallback' success!"
      }

      回调请求: (IPC往回调地址推送识别记录)

      {
      	"IP": "128.128.30.33",
      	"device_id":	"BD12345678901234",
      	"timestamp" : 1577690264,  //(UNIX时间戳:秒)
      	"user_id": "user_id",
      	"score": 80, //(80%相似度)
      	"image": "原图图片数据base64"
      }

      回调返回:

      成功:
      {
      	"code":	true,
      	"log":	"success!"
      失败:
      {
      	"code":	false,
      	"log":	"failed!"
      }

    13. 设备心跳回调

    • 说明

      用于检测设备是否在正常运行。

    • 请求

      方法

      URL

      Request Type

      setDeviceHeartBeat

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      callback_url

      回调地址

      Y

      详见下方回调信息

    • 回调信息

      • log信息
      • IP:设备所在IP
      • deviceID:设备序列号
      • timestamp:时间戳
      • user_num:设备上的用户数量
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setDeviceHeartBeat

      请求:

      {
      	"pass": "pass",
      	"callback_url": "http://128.128.30.39:8011/heartbeat"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setDeviceHeartBeat' success!"
      }

      回调请求: (IPC往回调地址推送心跳信息)

      成功:
      {
      	"code":	true,
      	"log":	"success!"
      }
      失败:
      {
      	"code":	false,
      	"log":	"failed!"
      }

    14. 用户信息变更回调

    • 说明

      用户注册成功后,向指定地址发送下注册成功的详细信息。

    • 请求

      方法

      URL

      Request Type

      setUserCallback

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      callback_url

      回调地址

      Y

      详见下方回调信息

    • 回调信息

      • log信息
      • device_id:设备序列号
      • timestamp:时间戳
      • user_id:用户名
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/setUserCallback

      请求:

      {
      	"pass": "pass",
      	"callback_url": "http://128.128.30.39:8011/user"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setUserCallback' success!"
      }

      回调请求: (IPC往回调地址推送用户注册信息)

      {
      	"device_id":	"BD12345678901234",
      	"timestamp" : 1577690264,  //(UNIX时间戳:秒)
      	"user_id": "user_id"
      }

      回调返回:

      成功:
      {
      	"code":	true,
      	"log":	"success!"
      }
      失败:
      {
      	"code":	false,
      	"log":	"failed!"
      }

    15.获取软件版本

    • 说明

      获得设备上运行的软件版本。

    • 请求

      方法

      URL

      Request Type

      getSoftVersion

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

    • 返回

      • log信息
      • 软件版本默认为三位号,1.0.0,第一位表示架构更新,第二位表示功能或模型变更,第三位表示bug修复或小功能修改
    • JSON 格式

      URL:http://设备IP:8080/deviceManage/getSoftVersion

      请求:

      {
      	"pass":"pass"
      }

      返回:

      {
      	"version": "1.0.0",
      	"code":	true,
      	"log":	"'getSoftVersion' success!"
      }
    3.2 用户管理接口
    • 设备管理POST URL:http://设备IP:8080/userManage
    • 设备管理请求类型:

      序号 Request type 说明
      1 addUser 用户注册
      2 deleteUser 用户删除
      3 getUserInfo 获取用户信息
      4 setUserAuthTime 设置用户有效期
      5 getUserList 用户权限有效期
      6 deleteUserImages 清除用户数据

    1. 用户注册或更新

    • 说明

      用户及人脸信息注册或更新。

    • 请求

      方法

      URL

      Request Type

      addUser

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      user_id

      用户唯一ID

      Y

       

      image_content

      w   image base64编码后的图片数据;

      w   URL图片的 URL地址,通过URL下载到本地;

      w   featureBASE64的特征值字符串

      Y

      图片信息,小于4MB,图片上传方式根据image_type来判断。支持jpg格式。

      image_type

      w   imageimage_contentBASE64的人脸图片

      w   URLimage内容将从人脸图片URL地址

      w   featureimage_contentBASE64的特征值字符串

      Y

       

      user_info

      用户资料,长度256B

      w   name:用户名(必须)

      w   phone_number:电话号码(非必须)

      w   other:其他信息(非必须)

      Y

       

      action_type

      图片注册操作方式

      w   APPEND:当user_id存在时,新注册的图片会追加到具体的user_id下面

      w   REPLACE:当user_id存在时,新注册的图片会替换掉原user下的所有图片

      默认 APPEND

      N

      每个user下,可以最多5图片,如果超过5,则append形式也会随机覆盖一张已有图片。

      quality_control

      图片质量控制

      NONE: 不进行控制

      LOW较低的质量要求

      NORMAL:一般的质量要求

      HIGH较高的质量要求

      默认 NONE

      若图片质量不满足要求,则返回结果中会提示质量检测失败

      N

      以下阈值越小代表越严格,0-1区间。

      光照比较特殊,取0-255区间

      ²  NONE:不经过质量判断模型

      ²  LOW:遮挡0.8、角度30°、光照不要求、模糊度 0.8

      ²  NORMAL:遮挡0.6、角度20°、光照不40-255、模糊度 0.6

      ²  HIGH:遮挡0.3、角度15°、光照不60-120、模糊度 0.3

      auth_start_time

      可以被识别的起始时间,传入unix时间戳

      N

      在有效时间内,用户可被识别。

      超过有效时间,用户将会被当做陌生人对待

      暂不支持此项。

      auth_end_time

      可以被识别的终止时间,传入unix时间戳

      N

    • 返回

      • log信息
      • 注册状态成功

        • user_id:用户名
        • position:人脸的左上和右下角点的坐标(x,y)
        • create_time:注册成功的时间
        • device_id: 设备ID
      • 注册状态失败:提示具体格式或质量控制不满足的反馈
    • JSON 格式

      URL:http://设备IP:8080/userManage/addUser

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id",
      	"image_content":"image.base64/image.url/feature.base64",
      	"image_type": "image/URL/feature",
      	"user_info": {
      		"name":"name",
      		"phone_number":"12345"
      	},
      	"action_type": "APPEND/REPLACE",
      	"quality_control": "NONE/LOW/NORMAL/HIGH",
      	"auth_start_time": 1577690264,
      	"auth_end_time": 1577690264
      }

      返回:

      {
      	"user_id": "user_id",
      	"position": {
      		"point_1":"(10,10)",
      		"point_2":"(80,80)"
      	},
      	"create_time": 1577690264,
      	"device_id": "device_id",
      	"code":	true,
      	"log":	"'addUser' success!"
      }

    2. 用户删除

    • 说明

      删除用户及对应的所有图片&特征值数据,不会删除已经产生的记录信息。

    • 请求

      方法

      URL

      Request Type

      deleteUser

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      user_id

      用户唯一id

      Y

      删除该用户,以及该用户下所有图片

    • 返回

      • log信息
      • user_id:被删除的用户名
      • 状态:删除成功与否
    • JSON 格式

      URL:http://设备IP:8080/userManage/deleteUser

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id"
      }

      返回:

      {
      	"user_id": "user_id",
      	"code":	true,
      	"log":	"'deleteUser' success!"
      }

    3. 获取用户信息

    • 说明

      获取具体用户下的相关信息。

    • 请求

      方法

      URL

      Request Type

      getUserInfo

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      设备连入公网情况下,

      user_id

      用户唯一ID

      Y

       

    • 返回

      • log信息
      • user_id
      • user_info
    • JSON 格式

      URL:http://设备IP:8080/userManage/getUserInfo

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id"
      }

      返回:

      {
      	"user_id": "user_id",
      	"user_info": {
      		"name":"name",
      		"phone_number":"12345"
      	},
      	"code":	true,
      	"log":	"'getUserInfo' success!"
      }

    4. 设置用户有效期

    • 说明

      调整用户的有效识别时间。(陌生人有效期暂不生效

    • 请求

      方法

      URL

      Request Type

      setUserAuthTime

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      设备连入公网情况下,

      user_id

      用户唯一标识

      Y

       

      auth_start_time

      可以被识别的起始时间,传入unix时间戳

      Y

      在有效时间内,用户可被识别。

      超过有效时间,用户将会被当做陌生人对待

      auth_end_time

      可以被识别的终止时间,传入unix时间戳

      Y

    • 返回

      • log信息
      • user_id
      • auth_start_time
      • auth_end_time
    • JSON 格式

      URL:http://设备IP:8080/userManage/setUserAuthTime

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id",
      	"auth_start_time": 1577690264,
      	"auth_end_time": 1577690264
      }

      返回:

      {
      	"user_id": "user_id",
      	"auth_start_time": 1577690264,
      	"auth_end_time": 1577690264
      	"code":	true,
      	"log":	"'setUserAuthTime' success!"
      }

    5. 查询用户列表信息

    • 说明

      获取设备上所有用户的列表信息。

    • 请求

      方法

      URL

      Request Type

      getUserList

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      设备连入公网情况下,

      start

      默认值0,起始序列

      N

      如不请求具体区间,则相当于查询全库下的用户信息。

      length

      默认值100,最大值1000

      N

    • 返回

      user_id_list:列表中包含所有用户的user_id

    • JSON 格式

      URL:http://设备IP:8080/userManage/getUserList

      请求:

      {
      	"pass": "pass",
      	"start": 0,
      	"length": 1000
      }

      返回:

      {
      	"user_id_list":[
      		"user_id",
      		"user_id",
      		"user_id",
      		"user_id",
      		"user_id"
      	],
      	"code":	true,
      	"log":	"'getUserList' success!"
      }

    6. 清空用户数据

    • 说明

      清空用户下所有图片数据,但保留其他所有用户信息(user_id、user_info、有效期等)

    • 请求

      方法

      URL

      Request Type

      deleteUserImages

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      设备连入公网情况下,

      user_id

      用户唯一标识

      Y

       

    • 返回

      • log信息
      • user_id
    • JSON 格式

      URL:http://设备IP:8080/userManage/deleteUserImages

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id"
      }

      返回:

      {
      	"user_id": "user_id",
      	"code":	true,
      	"log":	"'deleteUserImages' success!"
      }
    3.3 识别管理接口
    • 识别管理POST URL:http://设备IP:8080/recognitionManage
    • 识别管理请求类型:

      序号 Request type 说明
      1 getFeature 获取人脸特征值
      2 Match 人脸比对
      3 Identify 人脸搜索
      4 setDetectNum 多人脸检测
      5 setLivenessType 活体模式
      6 setQualityControl 质量控制
      7 setStranger 陌生人开关
      8 setMinSize 最小识别人脸
      9 setIntervalTime 识别间隔时间

    1. 获取人脸特征值

    • 说明

      对一张图片进行特征值抽取。

    • 请求

      方法

      URL

      Request Type

      getFeature

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      image_content

      w   image:图片的base64值,base64编码后的图片数据;

      w   URL图片的 URL地址,通过URL下载到本地;

      Y

      图片信息,小于4MB,图片上传方式根据image_type来判断。支持jpg格式。

      image_type

      w   imageimage_contentBASE64的人脸图片

      w   URLimage内容将从URL地址

      Y

       

    • 返回

      • log信息
      • 人脸特征 feature
    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/getFeature

      请求:

      {
      	"pass": "pass",
      	"image_content":"image.base64/image.url",
      	"image_type": "image/URL"
      }

      返回:

      {
      	"feature":"feature.base64",
      	"code":	true,
      	"log":	"'getFeature' success!"
      }

    2. 人脸对比

    • 说明

      对比两个图片或特征值的相似度得分。

    • 请求(json入参)

      方法

      URL

      Request Type

      match

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      image_content

      w   image base64编码后的图片数据;

      w   URL图片的 URL地址,通过URL下载到本地;

      w   featureBASE64的特征值字符串

      Y

      图片信息,小于4MB,图片上传方式根据image_type来判断。支持jpg格式。

      image_type

      w   imageimage_contentBASE64的人脸图片

      w   URLimage内容将从人脸图片URL地址

      w   featureimage_contentBASE64的特征值字符串

      Y

       

      quality_control

      图片质量控制

      NONE: 不进行控制

      LOW较低的质量要求

      NORMAL:一般的质量要求

      HIGH较高的质量要求

       

      默认 NONE若图片质量不满足要求,则返回结果中会提示质量检测失败

      N

      以下阈值越小代表越严格,0-1区间。

      光照比较特殊,取0-255区间

      ²  NONE:不经过质量判断模型

      ²  LOW:遮挡0.8、角度30°、光照不要求、模糊度 0.8

      ²  NORMAL:遮挡0.6、角度20°、光照不40-255、模糊度 0.6

      ²  HIGH:遮挡0.3、角度15°、光照不60-120、模糊度 0.3

    • 返回

      • log信息
      • score:相似度对比分数,百分比分值
    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/match

      请求:

      {
      	"pass": "pass",
      	"image1":{
      		"image_content":"image.base64/image.url/feature.base64",
      		"image_type": "image/URL/feature"
      	},
      	"image2":{
      		"image_content":"image.base64/image.url/feature.base64",
      		"image_type": "image/URL/feature"		
      	},
      	"quality_control": "NONE/LOW/NORMAL/HIGH"
      }

      返回:

      {
      	"score": 80, //(80%相似度)
      	"code":	true,
      	"log":	"'match' success!"
      }

    3. 人脸搜索

    • 说明

      用指定的一张人脸,在人脸库中搜索。

    • 请求

      方法

      URL

      Request Type

      identify

      名称

      定义

      必须

      备注

      Pass

      设备密码

      Y

      请求鉴权,需加密请求。

      image_content

      w   image base64编码后的图片数据;

      w   URL图片的 URL地址,通过URL下载到本地;

      w   featureBASE64的特征值字符串

      Y

      图片信息,小于4MB,图片上传方式根据image_type来判断。支持pngjpg格式

      注:两张图片通过json格式上传

      image_type

      w   imageimage_contentBASE64的人脸图片

      w   URLimage内容将从人脸图片URL地址

      w   featureimage_contentBASE64的特征值字符串

      Y

       

      quality_control

      图片质量控制

      NONE: 不进行控制

      LOW较低的质量要求

      NORMAL:一般的质量要求

      HIGH较高的质量要求

       

      默认 NONE若图片质量不满足要求,则返回结果中会提示质量检测失败

      N

      以下阈值越小代表越严格,0-1区间。

      光照比较特殊,取0-255区间

      ²  NONE:不经过质量判断模型

      ²  LOW:遮挡0.8、角度30°、光照不要求、模糊度 0.8

      ²  NORMAL:遮挡0.6、角度20°、光照不40-255、模糊度 0.6

      ²  HIGH:遮挡0.3、角度15°、光照不60-120、模糊度 0.3

      user_num

      搜索后返回的用户数量。

      默认为1,最多返回50

      N

       

    • 返回

      • log信息
      • user_list:用户信息列表(以score大小降序排列)

        • user_id:用户名
        • user_info:用户信息
        • score:相似度得分
    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/identify

      请求:

      {
      	"pass": "pass",
      	"image_content":"image.base64/image.url",
      	"image_type": "image/URL",
      	"quality_control": "NONE/LOW/NORMAL/HIGH",
      	"user_num": 1
      }

      返回:

      {
      	"user_list":[
      		{
      			"user_id": "user_id",
      			"user_info": {
      				"name":"name",
      				"phone_number":"12345"
      			},
      			"score": 80, //(80%相似度)
      		}
      	],
      	"code":	true,
      	"log":	"'identify' success!"
      }

    4. 多人脸检测

    • 说明

      是否开启多人脸检测,并设置对应参数。

    • 请求

      方法

      URL

      Request Type

      setDetectNum

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      detect_num

      默认为1,最大值5,用于管理设置可以同时检测多少张人脸

      Y

       

    • 返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setDetectNum

      请求:

      {
      	"pass": "pass",
      	"detect_num": 1
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setDetectNum' success!"
      }

    5. 活体模式

    • 说明

      管理应用的活体模式。

    • 请求

      方法

      URL

      Request Type

      setLivenessType

      名称

      定义

      必须

      备注

      Pass

      设备密码

      Y

      请求鉴权,需加密请求。

      liveness_type

      w   NONE:不使用活体

      w   RGB:使用可见光活体

      w   NIR:使用近红外活体

      w   RGB+NIR:使用可见光和近红外活体

      w   RGB+Depth:使用可见光和深度图模式(支持结构光和Tof方案)

      w   RGB+NIR+Depth:三种模态全部开启

      Y

       

    • 返回

      • log信息
      • liveness_type
    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setLivenessType

      请求:

      {
      	"pass": "pass",
      	"liveness_type": "NONE/RGB/NIR/RGB+NIR/RGB+Depth/RGB+NIR+Depth"
      }

      返回:

      {
      	"liveness_type": "NONE/RGB/NIR/RGB+NIR/RGB+Depth/RGB+NIR+Depth",
      	"code":	true,
      	"log":	"'setDetectNum' success!"
      }

    6. 质量控制

    • 说明

      用于人脸注册和识别过程中,质量控制的开关和具体值设置。

    • 请求

      方法

      URL

      Request Type

      setQualityControl

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      work_field

      w   ALL:全流程都开启质量控制

      w   ADDUSER:图片注册流程

      w   RECOGNITION:活体及识别全流程

      Y

       

      quality_control

      图片质量控制

      w   NONE: 不进行控制

      w   LOW较低的质量要求

      w   NORMAL:一般的质量要求

      w   HIGH较高的质量要求

       

      默认 NONE若图片质量不满足要求,则返回结果中会提示质量检测失败

      Y

      以下阈值越小代表越严格,0-1区间。

      光照比较特殊,取0-255区间

      ²  NONE:不经过质量判断模型

      ²  LOW:遮挡0.8、角度30°、光照不要求、模糊度 0.8

      ²  NORMAL:遮挡0.6、角度20°、光照不40-255、模糊度 0.6

      HIGH:遮挡0.3、角度15°、光照不60-120、模糊度 0.3

    • 返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setQualityControl

      请求:

      {
      	"pass": "pass",
      	"work_field": "ALL/ADDUSER/RECOGNITION",
      	"quality_control": "NONE/LOW/NORMAL/HIGH"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setQualityControl' success!"
      }

    7. 陌生人开关

    • 说明

      设置是否开启陌生人模式,以影响在非注册用户识别时的弹窗提示策略。

    • 请求

      方法

      URL

      Request Type

      setStranger

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      type

      1:开启;0:关闭

      开启情况下,则在任何模式下,非注册用户,在识别不通过情况下,都不会在界面有弹窗提示

      Y

       

    • 返回

      • log信息
    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setStranger

      请求:

      {
      	"pass": "pass",
      	"type": 0
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setStranger' success!"
      }

    8. 最小识别人脸

    • 说明

      可检测到的最小人脸尺寸,用于调整有效的识别距离。

    • 请求
    • 方法

      URL

      Request Type

      setMinSize

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      size

      单位:像素

      100,则人脸最大边长为100px

      最小支持30px

      默认为60px

      Y

       

      返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setMinSize

      请求:

      {
      	"pass": "pass",
      	"size": 60 
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setMinSize' success!"
      }

    9. 识别间隔时间

    • 说明

      每次识别之间的间隔时间,间隔时间内;仅检测人脸,但不识别。

    • 请求

      方法

      URL

      Request Type

      setIntervalTime

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      time

      单位:毫秒数

      100,则间隔时间为100ms

      默认为0

      Y

       

    • 返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recognitionManage/setIntervalTime

      请求:

      {
      	"pass": "pass",
      	"time": 0 
      }

      返回:

      {
      	"code":	true,
      	"log":	"'setIntervalTime' success!"
      }
    3.4 记录管理接口
    • 识别管理POST URL:http://设备IP:8080/recordManage
    • 识别管理请求类型:

      序号 Request type 说明
      1 SearchRecords 识别记录查询
      2 DeleteRecords 识别记录删除
      3 DeleteALLRecords 清除用户下所有记录

    1. 识别记录查询

    • 说明

      查询具体用户的识别记录。

    • 请求

      方法

      URL

      Request Type

      searchRecords

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      type

      请求的记录类型

      matchsearch

      match11对比记录

      search1N识别记录

      Y

       

      start_time

      记录起始时间,传入Unix时间戳

      Y

       

      end_time

      记录结束时间,传入Unix时间戳

      Y

       

      user_id

      指定具体用户

      N

      指定具体用户后,则拉取这个用户的数据;如未指定,则拉取所有数据

      order

      0:按照时间由远及近

      1:按照时间由近及远

      N

       

    • 返回

      • log信息
      • data数据

        • user_id:具体的用户
        • records_num:识别记录数量
        • type:match或search

          • type为match对比时:

            • score:相似度对比分数
            • face_list:两张人脸信息列表
          • type为search时:

            • user_list:用户信息列表(以score大小降序排列)

              • user_id:用户名
              • user_info:用户信息
              • score:相似度得分
    • JSON 格式

      URL:http://设备IP:8080/recordManage/searchRecords

      请求:

      {
      	"pass": "pass",
      	"type": "search",
      	"start_time": 1577690264,
      	"end_time": 1577690264,
      	"user_id": "user_id",
      	"order": 0
      }

      返回:

      {
      	"data":{
      		"type":"search",
      		"user_id":"user_id",
      		"records_num":1,
      		"user_list":[
      			{
      				"user_id": "user_id",
      				"user_info": {
      					"name":"name",
      					"phone_number":"12345"
      				},
      				"score":80
      			}
      		]
      	},
      	"code":	true,
      	"log":	"'searchRecords' success!"
      }

    2. 识别记录删除

    • 说明

      删除具体用户的识别记录。

    • 请求

      方法

      URL

      Request Type

      deleteRecords

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      user_id

      指定具体用户

      Y

       

      start_time

      记录起始时间,传入Unix时间戳

      Y

       

      end_time

      记录结束时间,传入Unix时间戳

      Y

       

      order

      0:按照时间由远及近

      1:按照时间由近及远

      N

      暂不支持此项。

    • 返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recordManage/deleteRecords

      请求:

      {
      	"pass": "pass",
      	"start_time": 1577690264,
      	"end_time": 1577690264,
      	"user_id": "user_id",
      	"order": 0
      }

      返回:

      {
      	"code":	true,
      	"log":	"'deleteRecords' success!"
      }

    3. 清空用户下所有记录

    • 说明

      删除用户下的所有记录

    • 请求

      方法

      URL

      Request Type

      deleteAllRecords

      名称

      定义

      必须

      备注

      pass

      设备密码

      Y

      请求鉴权,需加密请求。

      user_id

      指定具体用户

      Y

       

    • 返回

      log信息

    • JSON 格式

      URL:http://设备IP:8080/recordManage/deleteAllRecords

      请求:

      {
      	"pass": "pass",
      	"user_id": "user_id"
      }

      返回:

      {
      	"code":	true,
      	"log":	"'deleteAllRecords' success!"
      }
    上一篇
    产品概述
    下一篇
    硬件说明文档