软件协议文档
终端设备协议文档
功能&协议池（所有功能协议）
MQTT协议文档
HTTP协议文档
微光TLV协议文档
微光卡&码协议
功能模块&UI文档
人脸机
VF105
门禁标品MQTT协议文档（DejaOS版本）
Access control standard MQTT protocol document
VF系列HTTP协议接口文档V1.0.28（Vbar版本）
VF系列MQTT协议文档V1.37.0（Vbar版本）
VF系列-协议模式下通讯协议文档V1.0.4（Vbar版本）
VF203
门禁标品MQTT协议文档（DejaOS版本）
Access control standard MQTT protocol document
VF系列HTTP协议接口文档V1.0.28（Vbar版本）
VF系列-协议模式下通讯协议文档V1.0.4（Vbar版本）
VF系列-MQTT协议文档V1.37.2（Vbar版本）
VF 系列 HTTP 协议接口文档-V1.37.1（Vbar版本）
VF106
门禁标品MQTT协议文档（Android版本）
Access control standard MQTT protocol document
VF114
门禁标品MQTT协议文档（DejaOS版本）
Access control standard MQTT protocol document
VF系列HTTP协议接口文档V1.0.28（Vbar版本）
VF系列-协议模式下通讯协议文档V1.0.4（Vbar版本）
VF205
门禁标品MQTT协议文档（DejaOS版本）
VF系列HTTP协议接口文档V1.0.28（Vbar版本）
VF系列-协议模式下通讯协议文档V1.0.4（Vbar版本）
读头
EE200
读头标品TLV通讯协议
Read header standard TLV communication protocol
读头标品TLV通讯协议V3.10（Vbar版本）
TX200
读头标品TLV通讯协议
Read header standard TLV communication protocol
QT960
读头标品TLV通讯协议
Read header standard TLV communication protocol
QT660
读头标品TLV通讯协议
Read header standard TLV communication protocol
Q340
读头标品TLV通讯协议
Read header standard TLV communication protocol
M300
读头标品TLV通讯协议
Read header standard TLV communication protocol
读头标品TLV通讯协议V3.10（Vbar版本）
JL7000
读头标品TLV通讯协议
Read header standard TLV communication protocol
Q350
读头标品TLV通讯协议
Read header standard TLV communication protocol
MU86
读头标品TLV通讯协议
Read header standard TLV communication protocol
读头标品TLV通讯协议V3.10（Vbar版本）
MET
读头标品TLV通讯协议
Read header standard TLV communication protocol
扫码器TCP/HTT通讯协议V1.0（Vbar版本）
读头标品TLV通讯协议V3.10（Vbar版本）
M350
读头标品TLV通讯协议
Read header standard TLV communication protocol
读头标品TLV通讯协议V3.10（Vbar版本）
扫码器TCP/HTT通讯协议V1.0（Vbar版本）
DW200
读头标品TLV通讯协议（DejaOS版本）
Read header standard TLV communication protocol
读头标品HTTP&TCP协议文档（DejaOS版本）
读头标品HTTP&TCP协议文档（Vbar版本）
读头标品TLV通讯协议V3.10（Vbar版）
读头标品RS485一拖多协议V0.7（Vbar版本）
M340
读头标品TLV通讯协议
Read header standard TLV communication protocol
CR90
刷卡模块通信协议v3.0
CR90指令文档
微光指令:0x60 蓝牙设备控制
1.7/2.x扫码器配置字段说明文档
门禁
DW200
门禁标品MQTT协议文档（DejaOS版本）
Access control standard MQTT protocol document
门禁扫码器MQTT协议文档（Vbar版本）
MU86
门禁标品MQTT协议文档
Access control standard MQTT protocol document
门禁20180820 MQTT协议文档V1.0.2（Vbar版）
Q350
门禁标品MQTT协议文档
Access control standard MQTT protocol document
门禁20180820 MQTT协议文档V1.0.2（Vbar版）
MET
门禁标品MQTT协议文档
Access control standard MQTT protocol document
门禁20180820 MQTT协议文档V1.0.2（Vbar版）
M350
门禁标品MQTT协议文档
Access control standard MQTT protocol document
门禁20180820 MQTT协议V1.0.1（Vbar版本）
门禁20180820 MQTT协议文档V1.0.2（Vbar版本）
MP86
门禁20180820 MQTT协议文档V1.0.2（Vbar版本）
控制板
CC104
控制板标品MQTT协议文档
Control board standard MQTT protocol documentation
CC101
控制板标品MQTT协议文档
Control board standard MQTT protocol documentation
CC101标品20211101MQTT协议V3.6（Vbar版本）
平台服务协议文档
网关服务接口定义
门禁应用接口定义
工具文档
多弦产品API签名安全规则
海外锁
app和后台的mqtt协议
文档
-
+
首页
VF系列HTTP协议接口文档V1.0.28（Vbar版本）
# VF系列HTTP协议接口文档V1.0.28 # 一、接口说明 ## 1.1接口规范 1. 接口根地址：http://设备 ip 地址:8060/ 2. 接口形式：通过 HTTP 请求的方式对外提供服务。 3. 接口安全：初次调用接口需要先设置设备密码（pass），后续调用任何接口都需要传入设备密码（pass）作为接口安全校验秘钥。 ## 1.2接口返回 所有接口返回的数据，都包含至少四个字段，即 result、success、msg、code，分别表示处理结果（1 成功，0 失败）、操作结果（true 成功，false 失败）、返回信息、返回码。result、success 和 msg 称为基本字段。 | 字段 | 描述 | 类型 | 必传 | 说明 | |---------|----------|---------|------|--------------------------------------------------------------------------------------------| | result | 处理结果 | Int | Y | 1 成功，0 失败 | | success | 操作结果 | Boolean | Y | true 成功，false 失败 | | msg | 返回信息 | String | N | 接口返回信息，通常是错误信息 | | code | 返回码 | String | Y | 正常操作使用统一返回码，每个异 常操作有单独的返回码 详见表《[附表 1 Code 码总览](#附表1)》 | 除返回基本字段，大部分接口会返回业务数据，返回的字段统一为 data，称为业务字段。 | 字段 | 描述 | 类型 | 必传 | 说明 | |------|----------|--------------------------|------|--------------------------------------| | data | 返回数据 | Int/String/Object/List等 | N | 返回的数据，数值、字符串、对象或集合 | 文档中所涉及到的接口返回示例，个别接口的返回数据会有略微调整，须以真实的返回结果为准。 ## 1.3接口调用流程 首次使用设备：设备开机后进入识别主界面。设备未调通过接口，设备无初始密码。操作流程见流程图。  - 设备初始无密码，调用所有接口都需要传入密码参数；在设置设备密码接口，newPass和oldPass 传入一样的值，即成为设备密码 - 照片注册成功后，该注册照片会保存在设备内；可通过照片查询接口获得人员注册照片 url，访问 url 的照片时，设备需连网在线，且客户端与设备处于同一网段 - 人脸识别成功后，会显示注册人员的姓名；若填写了卡号，可直接刷对应卡号的卡进行识别，识别成功后会显示与该卡号对应的注册人员姓名 - 若设置了回调地址，人员识别成功后会向回调地址 POST 字段 ip、 personId、 time（识别时间）、 deviceKey 和 type：face/card/qrcode_0/1/2；若设置了公网回调地址，识别时设备离线或设备连局域网，则设备连公网后识别记录会上传到公网回调地址 ## 1.4注意事项 1. 调用设备接口时，请勿同时在其他客户端服务器上调用同一台设备的接口。 2. 若调用接口返回提示“参数异常”，请按以下步骤检查： 1. 检查参数名称是否拼错、参数名称中是否带有空格或回车。 2. 检查参数值是否符合规范，如 Int 值未定义、 id 含有数字字母以外的非法字符等。 3. Json 中是否含有空格（直接使用接口返回的 Json 字符串需要去空格），是否多了或少了"，请仔细核对每个接口的 postman 示例。 3. 若调用接口返回为空，表示 url 错误（IP 有误、拼写错误、字段遗漏等），如图所示。下图中 url 大小写有误。  4. 若调用接口返回 Could not get any response，可能原因有： IP 地址错误、端口号错误或遗漏、传参形式错误（POST 请求参数放在 body 里，格式为 x-www-urlencoded）等。 ## 1.5适用范围 此文档适用范围为： 1. 版本号为： VF102-V5.015X 及更高版本的设备。- 版本号中的 X 表示任意数字。 # 二、设备管理类接口 ## 2.1设置设备密码 请求数据 | Method | URL | |--------|---------------------------------| | POST | http://设备 IP:8060/setPassWord | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ------- | ------ | ------ | ---- | ------------------------------------------------------------ | | oldPass | 旧密码 | String | Y | 新设备或重置后（恢复初始化）的设备，调用其他接口前，需要先进行初始密码设置，oldPass 和newPass 传入一样的值即可 修改密码时，分别传入新、旧密码 此接口调用不需要传入 pass 密码不可为空或空格 | | newPass | 新密码 | String | Y | | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|--------|--------|------|----------| | data | 新密码 | String | Y | 新密码 | postman 示例  返回示例 ```c { "code": "LAN_SUS-0", "data": "test1234", //设备密码，也称接口调用密码，请妥善保管。若忘记密码，则需重置设备，设备会清空所有数据 "msg": "密码设置成功", "result": 1, //接口调通 "success": true //设备密码设置成功 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | | -------- | ------------ | -------------------------------------------- | ------------------------------------------------------------------------------------ | | 通用报错 | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | 参数异常 | LAN_EXP-2000 | oldPass 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-2001 | newPass 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | 其他 | LAN_EXP-2003 | 旧密码错误 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-2002 | 初次设置密码时，请确保 oldPass、newPass 相同 | 初次设置密码时， oldPass、 newPass 值要相等 | | 操作正确 | LAN_SUS-0 | 密码修改成功 | 设备使用新密码 | | | LAN_SUS-0 | 密码设置成功 | 设备已设置密码 | ## 2.2Web Server 登录/修改密码 请求数据 | Method | URL | |--------|---------------------------| | GET | http://设备 IP:8060/login | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |--------------|------------|--------|------|----------|-----------------------------------| | userName | 用户名 | String | N | admin | 用户名固定为：admin | | userPassword | 用户密码 | String | Y | password | 密码 | | newPassword | 用户新密码 | String | N | | 传空或不传为登录 传非空为修改密码 | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|------------------|---------|------|---------------------| | data | 是否设置接口密码 | Object | N | 详见\表 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |---------------|------------------|--------|------|-------------------------| | isSetPassword | 是否设置接口密码 | Int | Y | 0：未设置，1：已设置 | | password | http接口密码 | String | Y/N | IsSetPassword 为1时必传 | postman 示例  返回示例 ```c 未设置htpp接口密码 { "msg": "success", "code": "LAN_SUS-0", "success": true, "result": 1, "data": { "isSetPassword": 0 } } 已设置htpp接口密码 { "msg": "success", "code": "LAN_SUS-0", "success": true, "result": 1, "data": { "isSetPassword": 1, "password": "666666" } } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |------------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数不合法 | LAN_EXP-2030 | userName参数异常 | | | | LAN_EXP-2031 | passworde参数异常 | | | | LAN_EXP-2032 | 用户不存在 | | | | LAN_EXP-2033 | 密码错误 | | | 操作正确 | LAN_SUS-0 | 登录、修改成功 | 设备信息查询成功 | ## 2.3设备序列号（SN）获取 请求数据 | Method | URL | |----------|----------------------------------| | POST/GET | http://设备 IP:8060/getDeviceKey | Body 域为空 ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|--------|--------|------|-------------------------------| | data | 序列号 | String | N | 成功返回序列号（设备MAC地址） | - 注意：调用该接口不需要传入参数，不需要传入 pass， **使用 GET 或 POST 方法都可调通**  返回示例 ```c { "code": "LAN_SUS-0", "data": "yGmbv4SGfRmh", //设备序列号，设备出厂唯一标识码 "msg": "获取设备号成功", "result": 1, //接口调通 "success": true //成功获取设备序列号 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 其他 | LAN_EXP-2300 | 读取SN失败 | 设备未烧录SN | | 操作正确 | LAN_SUS-0 | / | "data": "yGmbv4SGfRmh" | ## 2.4设备配置 请求数据 | Method | URL | |--------|-------------------------------| | POST | http://设备 IP:8060/setConfig | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ------ | ------------ | ------ | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | config | 设备配置集合 | JSON | Y | config 传入{}，所有设备配置参数恢复默认值 其他参数均为非必传，若不传则保留上次传入的值。 Json 示例: { "pass": "666666", "config": { "tcpEn": 1, "tcpServerIp": "10.200.52.151", "tcpServerPort": 8060, "rsBaudrate": "115200-8-N-1", "wgDataSize": 34, "relayDelay": 2000, "recMode": 3, "faceCardMode": 1, "faceCardThreshold": 30, "scannerWorkMode": 2, "faceWorkMode": 2, "protocolChannel": 1, "protocolActionSuc": 1, "protocolActionFailed": 1, "httpAddr": "http://192.168.2.19:8080/sendTest", "httpTimeout": 2000, "qrEn": 1, "qrAffixesFt": 1, "qrPrefix": "", "qrPostfix": "", "qrCr": 0, "qrNl": 0, "qrFt": 0, "nfcEn": 1, "nfcFt": 0, "nfcOrd": 0, "nfcAffixesFt": 1, "nfcPrefix": "", "nfcPostfix": "", "nfcCr": 0, "nfcNl": 0, "nfcReadIdNum": 0, "cusTag0": "1", "cusTag1": "0", "cusTag2": "cus_tag2", "cusTag3": "cus_tag3", "cusTag4": "cus_tag4" "faceCheckSucVoice": 2, "faceCheckSucRelay": 1, "faceCheckSuc485": 2, "faceCheckSuc485Data": "face485data", "faceCheckSucWg": 1, "faceCheckSucWgData": 1234567890, "faceCheckFailedVoice": 2, "faceCheckFailedVoiceData": "人脸认证失败", "faceCheckSucVoiceData": "人脸认证成功", "cardCheckSucVoice": 2, "cardCheckSucRelay": 1, "cardCheckSuc485": 2, "cardCheckSuc485Data": "card485data", "cardCheckSucWg": 1, "cardCheckSucWgData": 9876543210, "cardCheckFailedVoice": 1, "cardCheckFailedVoiceData": "刷卡失败", "cardCheckSucVoiceData": "刷卡成功", "qrCheckSucVoice": 2, "qrCheckSucRelay": 1, "qrCheckSuc485": 2, "qrCheckSuc485Data": "qr485data", "qrCheckSucWg": 1, "qrCheckSucWgData": 1234567890, "qrCheckFailedVoice": 1, "qrCheckFailedVoiceData": "扫码失败", "qrCheckSucVoiceData": "扫码成功", "nameShow": 1, "ipShow": 1, "snShow": 1, "language": 0, "autoScreenOff": 1, "autoScreenOffTime": 600, "autoScreenSaverOff": 1, "autoScreenSaverTime": 300, "autoDisplayBrightness": 1, "displayBrightness": 50, "volume": 80, "deviceName": "大门", "autoSetTime": 1, "autoSetTimezone": 1, "timezone": "Asia/Shanghai", "maxTrackFaces": 1, "recgThreshold": 54, "living": 1, "alarmTemperature": 37.3, "bodyTemperatureDetect": 0, "exposureValues": 0, "faceRecgEnable": 1, "infraredEnable": 0, "livingDetectThresholdScore": 10, "maskDetectEnable": 0, "maskEnable": 1, "maskThresholdValue": 53, "recgDistance": 150, "recgInterval": 1000, "recgTimeout": 1000, "repeatRecgEnable": 1, "strangerVoice": 3, "temperatureCompensation": 0, "voiceMode": 0, "grettings": 0, "infraredLightSet": 1, "lightSensitive": 1, "lightHighBrightness": 1100, "lightLowBrightness": 500, "lightDetInterval": 1, "lightDelayTime": 10, "lightBrightness": 100, "tamperSwitch": 0, "alarmSwitch": 1, "doorSensorDelay": 3, "doorSensor": 1, "alarmOutputSwitch": 0, "alarmRelay": 1, "alarmWgData": 11112222, "alarm485Data": "alarm485Data", "alarmVoiceData": "", "saveLargePic": 1, "saveSmallPic": 3, "saveStrangerRecord": 1, "avoidAttendanceStep": 2, "mqttAddr": "123.207.152.144:61613", "mqttClientId": "", "mqttUserName": "admin", "mqttUserPassword": "password", "mqttTopicPrefix": "", "mqttMessageQos": 2, "dc_en": 0, "dc_open_timeout": 5, "dc_close_timeout": 5 }} | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|--------|------|---------------------------| | data | 设备配置 | Object | Y | 成功时返回 对应设置的配置 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1, "data": { "tcpEn": 1, "tcpServerIp": "10.200.52.151", "tcpServerPort": 8060, "rsBaudrate": "115200-8-N-1", "wgDataSize": 34, "recMode": 3, "scannerWorkMode": 2, "faceWorkMode": 2, "protocolChannel": 1, "protocolActionSuc": 1, "protocolActionFailed": 1, "httpAddr": "http://192.168.2.19:8080/sendTest", "httpTimeout": 2000, "relayDelay": 2000, "qrEn": 1, "qrAffixesFt": 1, "qrPrefix": "", "qrPostfix": "", "qrCr": 0, "qrNl": 0, "qrFt": 0, "nfcEn": 1, "nfcFt": 0, "nfcOrd": 0, "nfcAffixesFt": 1, "nfcPrefix": "", "nfcPostfix": "", "nfcCr": 0, "nfcNl": 0, "nfcReadIdNum": 0, "cusTag0": "1", "cusTag1": "0", "cusTag2": "cus_tag2", "cusTag3": "cus_tag3", "cusTag4": "cus_tag4" "faceCheckSucVoice": 2, "faceCheckSucRelay": 1, "faceCheckSuc485": 2, "faceCheckSuc485Data": "face485data", "faceCheckSucWg": 1, "faceCheckSucWgData": 1234567890, "faceCheckFailedVoice": 2, "faceCheckFailedVoiceData": "人脸认证失败", "faceCheckSucVoiceData": "人脸认证成功", "cardCheckSucVoice": 2, "cardCheckSucRelay": 1, "cardCheckSuc485": 2, "cardCheckSuc485Data": "card485data", "cardCheckSucWg": 1, "cardCheckSucWgData": 9876543210, "cardCheckFailedVoice": 1, "cardCheckFailedVoiceData": "刷卡失败", "cardCheckSucVoiceData": "刷卡成功", "qrCheckSucVoice": 2, "qrCheckSucRelay": 1, "qrCheckSuc485": 2, "qrCheckSuc485Data": "qr485data", "qrCheckSucWg": 1, "qrCheckSucWgData": 1234567890, "qrCheckFailedVoice": 1, "qrCheckFailedVoiceData": "扫码失败", "qrCheckSucVoiceData": "扫码成功", "alarmOutputSwitch": 0, "alarmRelay": 1, "alarmWgData": 11112222, "alarm485Data": "alarm485Data", "alarmVoiceData": "", "ipShow": 1, "snShow": 1, "nameShow": 1, "autoScreenOff": 1, "autoScreenOffTime": 600, "autoScreenSaverOff": 1, "autoScreenSaverTime": 300, "autoDisplayBrightness": 1, "displayBrightness": 50, "volume": 80, "deviceName": "", "infraredLightSet": 1, "lightSensitive": 1, "lightHighBrightness": 1100, "lightLowBrightness": 500, "lightDetInterval": 1, "lightDelayTime": 10, "alarmSwitch": 1, "doorSensorDelay": 3, "doorSensor": 1, "lightBrightness": 100, "tamperSwitch": 0, "autoSetTime": 1, "autoSetTimezone": 1, "timezone": "Asia/Shanghai", "recgThreshold": 54, "faceCardThreshold": 30, "faceCardMode": 1, "living": 1, "alarmTemperature": 37.3, "bodyTemperatureDetect": 0, "exposureValues": 0, "faceRecgEnable": 1, "infraredEnable": 0, "livingDetectThresholdScore": 10, "maskDetectEnable": 0, "maskEnable": 1, "maskThresholdValue": 53, "recgDistance": 150, "recgInterval": 1000, "recgTimeout": 1000, "repeatRecgEnable": 1, "strangerVoice": 3, "temperatureCompensation": 0, "voiceMode": 0, "grettings": 0 } } ``` 参数说明 | 字段名称 | 类型 | 含义及取值 | | -------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | | 所有配置参数为非必传，需要配置什么只需传对应字段即可 | | Channel 相关配置 | | | | tcpEn | Int | TCP 开关，0：关（默认） 1：开 | | tcpServerIp | String | TCP 服务器 IP | | tcpServerPort | Int | TCP 服务器端口号 | | rsBaudrate | String | RS485 波特率，默认："115200-8-N-1" | | wgDataSize | Int | 26：韦根 26， 34：韦根 34， 默认；34 | | relayDelay | Int | 继电器延时时间，单位：毫秒，分度：50ms，默认：2000 | | relayType | int | 继电器工作方式 0：设备自身继电器 1：SA100 安全模块 | | only_device | Int | 更新类型，0：更新设备 ；1：更新设备和安全模块 | | SA100EncryptionAesKey | String | AES 密钥（密钥更新需要连接 sa100，更新失败不会保存） | | SA100EncryptionAesIv | String | AES 偏移 | | SA100EncryptionSm4Key | String | SM4 密钥 | | SA100EncryptionSm4Iv | String | SM4 偏移 | | SA100EncryptionSm2Key | String | SM2 私钥 | | SA100EncryptionSm2Public | String | SM2 公钥 | | SA100Delay | Int | 模块继电器延迟 单位：毫秒，分度：50ms | | SA100EncryptionType | Int | 模块验证方式，1：AES 2：SM2 4：SM4 | | | 认证模式相关配置 | | | | recMode | Int | 识别模式（1：人/卡合一，2：人/码合一，3：人/卡/码任一, 4：人证核验） | | faceCardThreshold | Int | 人证核验相似度阀值， 用于判断这个人是否和身份证照片识别通过（0\~100）默认：30 | | faceCardMode | Int | 仅识别模式为人证核验时有效 0：仅陌生人仅进行人证核验 1：所有人进行人证核验 | | scannerWorkMode | Int | 工作模式（针对刷卡/扫码 1：透传模式，2：协议模式，3：开发模式，4：本地白名单模式）注：当为开发模式时，faceWorkMode 亦会同时变为开发模式 | | faceWorkMode | Int | 工作模式（针对刷脸 1：透传模式，2：协议模式 3：开发模式，4：本地白名单模式）注：当为开发模式时，faceWorkMode 亦会同时变为开发模式 | | onlineCheck | Int | 当 scannerWorkMode=4 或 faceWorkMode=4 时有效 1：优先离线。0：只离线 | | protocolChannel | Int | 协议通道（ 1：HTTP，2：485，3：TCP）注：当为开发模式时此配置配开发模式下通道不支持 HTTP，若配置 HTTP 会默认走 TCP | | protocolActionSuc | Int | 协议验证成功动作（0：无动作，1：播报语音，2：输出继电器，3：语音和继电器） | | protocolActionFailed | Int | 协议验证失败动作（ 0：无动作，1：播报语音） | | httpAddr | String | HTTP 协议回调地址 | | httpTimeout | Int | HTTP 请求超时时间 毫秒 | | 扫码相关配置 | | | | qrEn | Int | 扫码开关：0：关闭， 1：打开（默认） | | qrAffixesFt | Int | 二维码前后缀格式，1：字符串格式，2：十六进制格式 | | qrPrefix | String | 前缀，默认：""（空） | | qrPostfix | String | 后缀，默认：""（空） | | qrCr | Int | 1：末尾加回车，0：不加回车 | | qrNl | Int | 1：末尾加换行，0：不加换行 | | qrFt | Int | 韦根输出格式转换 0：原始二进制字符 不做转换 以下 bit 位 为 1 有效 bit0：数字字符转 hex ："1234" --\> 0x04D2 bit1：数字字符转 hex 反序 ："1234" --\> 0xD204 bit2：hex 字符转 hex ："abcd" --\> 0xabcd bit3：hex 字符转 hex 反序 ："abcd" --\> 0xcdab bit4：数字字符转 pid vid bit5：数字字符转 pid vid 反序 bit6：韦根 26 输出低 3 字节（当 bit4 or bit5 为 1 时有效） | | 刷卡相关配置 | | | | nfcEn | Int | 刷卡开关：0：关闭， 1：打开（默认） | | nfcFt | Int | 格式转换，0：不转换，1：转成 16 进制字符格式输出，2：转成 10 进制字符输出 | | nfcOrd | Int | 1：反序，0：正序 | | nfcAffixesFt | Int | 刷卡前后缀格式，1：字符串格式，2：十六进制格式 | | nfcPrefix | String | 前缀，默认：""（空） | | nfcPostfix | String | 后缀，默认：""（空） | | nfcCr | Int | 1：末尾加回车，0：不加回车 | | nfcNl | Int | 1：末尾加换行，0：不加换行 | | nfcReadIdNum | Int | 1：读取身份证号（云证），0：读取身份证物理卡号 | | nfcReadIdNumLen | Int | 读取身份证号长度（0-240） | | idDetailed | Int | 身份详细信息，支持多选 姓名:1, 性别: 2, 民族: 4, 出生: 8, 住址: 16, 号码: 32, 签发: 64, 生效: 128, 失效: 256, 图片: 512 | | nfcPublic | String | 一卡一密公钥 | | nfcType | Int | 刷卡类型，0：普通 1：一卡一密 2：固定块 | | nfcPiece | Int | 读取块 | | nfcKey | Int | 固定块密钥 | | cusTag0 | String | 自定义配置，主要用于定制 cusTag0\~ cusTag9 共 10 个 | | cusTag1 | String | | | cusTag2 | String | | | cusTag3 | String | | | cusTag4 \~ cusTag9 | String | | | 人脸相关配置 | | | | recgThreshold | Int | 人脸相似度阀值， 用于判断这个人是否识别通过（50\~100）默认：54 | | registerThreshold | Float | 注册阈值，人员相似度阈值（50\~100），当人员相似度达到此值时将会导致注册失败 | | living | Int | 1： 开启活检（默认）， 0： 关闭活检 | | alarmTemperature | Int | 默认 37.3 | | bodyTemperatureDetect | Int | 1： 打开测温服务模块开关，0： 关闭（默认） | | exposureValues | Int | 曝光补偿，默认：0 | | maxTrackFaces | Int | 人脸识别数配置[1,5] | | faceRecgEnable | Int | 人脸识别：1： 开启，0： 关闭 | | infraredEnable | Int | 红外图像：1： 开启，0： 关闭 | | livingDetectThresholdScore | Int | 活体检测阈值（0\~100）默认（10）， 活检算法每次判断人脸视频帧是否活体， 并给出一个分数， 当这个分数累计大于阈值后， 就认为当前是活体， 活体检测阈值越大需要活检的分数越高， 非活体攻击难度越大， 同时可能会影响活体通过率。 | | maskDetectEnable | Int | 口罩检测，1：打开，0：关闭（默认） | | maskEnable | Int | 口罩识别，1：打开（默认），0：关闭 | | maskThresholdValue | Int | 口罩阈值（0\~100），默认：53 | | recgDistance | Int | 识别距离（50\~150cm），默认：150 | | recgInterval | Int | 重复识别的时间间隔单位毫秒 ms，默认：1500，需大于 recgTimeout | | recgTimeout | Int | 识别超时单位毫秒 ms，默认：1000，最低 1000 | | ~~avoidAttendanceStep~~ | ~~Int~~ | ~~重复播报间隔。单位秒 s,默认 3，最小 2 秒~~ | | repeatRecgEnable | Int | 重复识别开关，1：打开（默认），0：关闭 | | strangerVoice | Int | 陌生人语音对应 0 无语音，1：播放请先注册，2：播陌生人你好 | | temperatureCompensation | Int | 温度补偿，默认：0 | | voiceMode | Int | 语音模式对应 0 无语音，1 报名字，2 播放问候语 | | grettings | Int | 问候语对应 0 无语音，1：播放打卡成功，2：播放请通行，3：播放欢迎光临，4：播放时间问候语 | | 补光灯相关设置 | | | | infraredLightSet | Int | 补灯光模式，0：长闭，1：长开，2：自动模式 | | lightSensitive | Int | 光敏控制（暂时没有使用），1：打开（默认），0：关闭 | | lightHighBrightness | Int | 环境光高于此值关闭红外检测人脸是否进入识读区域 | | lightLowBrightness | Int | 环境光低于此值且有人脸进入识读区域打开补光 | | lightDetInterval | Int | 环境光检测间隔，单位秒，默认：1s | | lightDelayTime | Int | 自动模式下补光灯亮起延时时间，单位秒，默认：15s | | lightBrightness | Int | 补光灯亮度 | | 设备放拆除设置 | | | | tamperSwitch | Int | 防拆开关，1：打开，0：关闭 | | 报警相关配置 | | | | alarmSwitch | Int | 报警服务开关，1：打开，0：关闭 | | doorSensorDelay | Int | 报警延时，报警信号出发多久后执行，单位秒，默认：30s | | doorSensor | Int | 报警信号触发类型，0：与地断开触发，1：与地短接触发，2：不触发（默认） | | alarmOutputSwitch | Int | 报警触发输出开关，1：打开（默认），0：关闭 | | alarmRelay | Int | alarmOutputSwitch=1 有效 1：输出继电器，0：不输出继电器 | | alarmWgData | Int | alarmOutputSwitch=1 有效 0：不输出韦根，n：韦根输出 n | | alarm485Data | String | alarmOutputSwitch=1 有效 ""（空）：不输出 485，"abcd"：485 输出"abcd" | | ~~alarmVoiceData~~ | ~~String~~ | ~~alarmOutputSwitch=1 有效 ""（空）：播放默认语音，"警报"：播放 "警报"~~ | | 语音、输出相关配置 | | | | faceCheckSucVoice | Int | 人脸核验成功语音：0：无语音，1：播放默认语音，2：播放自定义语音 | | faceCheckSucVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | faceCheckSucRelay | Int | 人脸核验成功继电器，0：无动作，1：输出继电器 | | faceCheckSuc485 | Int | 人脸核验成功 485 输出，0：无输出，1：输出自定义数据，2：输出人员 ID | | faceCheckSuc485Data | String | 人脸核验成功 485 输出数据 | | faceCheckSucWg | Int | 人脸核验成功韦根输出 0: 无输出，1：输出自定义数据，2：输出人员 ID | | faceCheckSucWgData | Int | 人脸核验成功韦根输出数据。韦根 26 范围为 1-65535，有效范围为 5 位；韦根 34 范围为 1-4294967295，有效范围为 10 位。若超出范围，则输出的信号会进行转换，输出无效信号。 | | faceCheckFailedVoice | Int | 人脸核验失败语音，0：无语音，1：播放默认语音，2：播放自定义语音 | | faceCheckFailedVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | cardCheckSucVoice | Int | 刷卡核验成功语音：0：无语音，1：播放默认语音，2：播放自定义语音 | | cardCheckSucVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | cardCheckSucRelay | Int | 刷卡核验成功继电器，0：无动作，1：输出继电器 | | cardCheckSuc485 | Int | 刷卡核验成功 485 输出，0：无输出，1：输出自定义数据，2：输出卡号 | | cardCheckSuc485Data | String | 刷卡核验成功 485 自定义输出数据 | | cardCheckSucWg | Int | 刷卡核验成功韦根输出，0：无输出，1：输出自定义数据，2：输出卡号 | | cardCheckSucWgData | Int | 人脸核验成功韦根输出数据。韦根 26 范围为 1-65535，有效范围为 5 位；韦根 34 范围为 1-4294967295，有效范围为 10 位。若超出范围，则输出的信号会进行转换，输出无效信号。 | | cardCheckFailedVoice | Int | 刷卡核验失败语音，0：无语音，1：播放默认语音，2：播放自定义语音 | | cardCheckFailedVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | qrCheckInterval | Int | 扫码间隔 默认 1000 毫秒 | | qrCheckSucVoice | Int | 扫码核验成功语音：0：无语音，1：播放默认语音，2：播放自定义语音 | | qrCheckSucVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | qrCheckSucRelay | Int | 扫码核验成功继电器，0：无动作，1：输出继电器 | | qrCheckSuc485 | Int | 扫码核验成功 485 输出，0：无输出，1：输出自定义数据，2：输出卡号 | | qrCheckSuc485Data | String | 人脸核验成功 485 输出数据 | | qrCheckSucWg | Int | 扫码核验成功韦根输出，0：无输出，1：输出自定义数据，2：输出卡号 | | qrCheckSucWgData | Int | 人脸核验成功韦根输出数据。韦根 26 范围为 1-65535，有效范围为 5 位；韦根 34 范围为 1-4294967295，有效范围为 10 位。若超出范围，则输出的信号会进行转换，输出无效信号。 | | qrCheckFailedVoice | Int | 扫码核验失败语音，0：无语音，1：播放默认语音，2：播放自定义语音 | | qrCheckFailedVoiceData | String | 1：上传成功，0：未上传 （中文版保存自定义语音，外文版保存上传状态） | | 通行记录相关配置 | | | | saveLargePic | Int | 全景图片：1：保存，0 ：不保存 | | saveSmallPic | Int | 人脸图片：1：保存，0 ：不保存 | | saveStrangerRecord | Int | 陌生人记录：1：保存，0 ：不保存 | | UI 相关配置 | | | | autoDisplayBrightness | Int | 自动调节屏幕亮度，0：关闭（默认），1：打开 | | displayBrightness | Int | 屏幕亮度（0-100）默认：80 | | autoScreenOff | Int | 自动息屏，0：关闭，1：打开（默认） | | autoScreenOffTime | Int | 自动息屏时间，默认：300 秒 | | autoScreenSaverOff | Int | 自动屏保，0：关闭，1：打开（默认） | | autoScreenSaverTime | Int | 自动屏保时间，默认：30 秒 | | snShow | Int | 显示 SN，0：不显示，1：显示 | | ipShow | Int | 显示 IP，0：不显示，1：显示 | | nameShow | Int | 显示姓名，0：不显示，1：显示 | | logoShow | Int | 显示 logo，0：不显示，1：显示 | | opendoorShow | Int | 显示 密码开门界面，0：不显示，1：显示 | | volume | Int | 音量（0-100），默认：50 | | autoSetTime | Int | 自动更新时间：0：关闭，1：打开（默认） | | ntpAddress | String | NTP服务地址，如：182.92.12.11:123 | | ~~autoSetTimezone~~ | ~~Int~~ | ~~自动设置时区：0：关闭，1：打开（默认）~~ | | timezone | String | 时区，默认："Europe/London"，可用时区参见《附表 2 可用时区列表》 | | deviceName | String | 默认：大门，任意字符串长度小于 128 | | deviceDirection | Int | 设备位置，1：进（默认），2：出，3：进/出 | | language | Int | 0：中文， 1：英文 ，2：日语，3：西班牙，4：法语，5：俄语，6：阿拉伯语 （中文版与外文版不可切换，外文版之间可以切换） | | MQTT 相关配置 | | | | mqttAddr | String | 123.207.152.144:61613 | | mqttClientId | String | 默认为设备 SN\_时间戳 | | mqttUserName | String | admin | | mqttUserPassword | String | password | | mqttTopicPrefix | String | MQTT 订阅主题的前缀 | | mqttMessageQos | Int | QoS0，At most once，至多一次 QoS1，At least once，至少一次 QoS2，Exactly once，确保只有一次 | | 门磁相关配置 | | | | dc_en | Int | 门磁状态持续检测开关 1:打开持续检测 0:关闭持续检测 | | dc_open_timeout | Int | 门磁打开超时时间，超时未打开发出提示 | | dc_close_timeout | Int | 门磁关闭超时时间，超时未关闭发出提示 | 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2800 | config 参数异常 | config 参数异常 | | 操作正确 | LAN_SUS-0 | 设置成功 | "data":{设备配置参数} | ## 2.5设备配置查询 请求数据 | Method | URL | |--------|-----------------------------------| | GET | http://设备 IP:8060/device/config | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|--------|------|----------| | pass | 设备密码 | String | Y | | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|---------|------|---------------------| | data | 设备配置 | Object | N | 详见\表 | Data 数据 \<……参数说明（[参照设备配置参数说明](#设备配置说明)）\> | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |------------|-----------|--------|------|---------------------------------------| | …… | …… | …… | … | [参照设备配置参数说明](#设备配置说明) | | netType | 网络类型 | Int | Y | 0：以太网，1：WiFi | | ssid | WiFi账号 | String | Y | | | pwd | WiFi密码 | String | Y | | | isDHCPMod | DHCP 模式 | bool | Y | True或 false | | ip | ip 地址 | String | Y | 例：192.168.1.123 | | gateway | 网关 | String | Y | 例：192.168.1.1 | | subnetMask | 子网掩码 | String | Y | 例：255.255.255.0 | | DNS | DNS服务器 | String | Y | 例：114.114.114.114 |  返回示例 ```c { "msg": "success", "code": "LAN_SUS-0", "success": true, "result": 1, "data": { "tcpEn": 0, "tcpServerIp": "10.102.106.116", "tcpServerPort": 8060, "rsBaudrate": "115200-8-N-1", "wgDataSize": 34, "relayDelay": 2000, "qrEn": 1, "qrAffixesFt": 1, "qrPrefix": "", "qrPostfix": "", "qrCr": 0, "qrNl": 0, "qrFt": 0, "nfcEn": 1, "nfcFt": 0, "nfcOrd": 0, "nfcAffixesFt": 1, "nfcPrefix": "", "nfcPostfix": "", "nfcCr": 0, "nfcNl": 0, "nfcReadIdNum": 0, "cusTag0": "1", "cusTag1": "0", "cusTag2": "cus_tag2", "cusTag3": "cus_tag3", "cusTag4": "cus_tag4" "faceCheckSucVoice": 1, "faceCheckSucRelay": 1, "faceCheckSuc485": 1, "faceCheckSuc485Data": "face485data", "faceCheckSucWg": 2, "faceCheckSucWgData": 1234567890, "faceCheckFailedVoice": 1, "faceCheckFailedVoiceData": "人脸认证失败", "faceCheckSucVoiceData": "人脸认证成功", "cardCheckSucVoice": 1, "cardCheckSucRelay": 1, "cardCheckSuc485": 1, "cardCheckSuc485Data": "card485data", "cardCheckSucWg": 2, "cardCheckSucWgData": 1233211230, "cardCheckFailedVoice": 1, "cardCheckFailedVoiceData": "刷卡失败", "cardCheckSucVoiceData": "刷卡成功", "qrCheckSucVoice": 1, "qrCheckSucRelay": 1, "qrCheckSuc485": 2, "qrCheckSuc485Data": "qr485data", "qrCheckSucWg": 1, "qrCheckSucWgData": 9876543210, "qrCheckFailedVoice": 1, "qrCheckFailedVoiceData": "扫码失败", "qrCheckSucVoiceData": "扫码成功", "alarmOutputSwitch": 1, "alarmRelay": 1, "alarmWgData": 0, "alarm485Data": "", "alarmVoiceData": "", "ipShow": 1, "snShow": 1, "nameShow": 1, "autoScreenOff": 1, "autoScreenOffTime": 300, "autoScreenSaverOff": 1, "autoScreenSaverTime": 30, "autoDisplayBrightness": 0, "displayBrightness": 50, "volume": 70, "deviceName": "大门", "infraredLightSet": 2, "lightSensitive": 1, "lightHighBrightness": 1100, "lightLowBrightness": 500, "lightDetInterval": 1, "lightDelayTime": 10, "alarmSwitch": 0, "doorSensorDelay": 3, "doorSensor": 2, "lightBrightness": 80, "tamperSwitch": 0, "autoSetTime": 1, "timezone": "Etc/UTC+8", "maxTrackFaces": 1, "recgThreshold": 54, "faceCardThreshold": 30, "faceCardMode": 1, "living": 1, "alarmTemperature": 37.3, "bodyTemperatureDetect": 0, "exposureValues": 0, "faceRecgEnable": 1, "infraredEnable": 0, "livingDetectThresholdScore": 10, "maskDetectEnable": 0, "maskEnable": 1, "maskThresholdValue": 53, "recgDistance": 150, "recgInterval": 1000, "recgTimeout": 1000, "repeatRecgEnable": 1, "strangerVoice": 3, "temperatureCompensation": 0, "voiceMode": 0, "grettings": 0, "saveLargePic": 0, "saveSmallPic": 1, "saveStrangerRecord": 0, "avoidAttendanceStep": 10, "mqttAddr": "123.207.152.144:61613", "mqttClientId": "", "mqttUserName": "admin", "mqttUserPassword": "password", "mqttTopicPrefix": "", "mqttMessageQos": 2, "dc_en": 0, "dc_open_timeout": 5, "dc_close_timeout": 5 } } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 查询成功 | pass 正确即可 | ## 2.6隐藏 IP、设备序列号、logo、密码开门 请求数据 | Method | URL | |--------|----------------------------------| | POST | http://设备 IP:8060/widgetConfig | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | | ------------ | -------------------- | ------ | ---- | ---- | ----------------------- | | pass | 设备密码 | String | Y | | | | ipShow | 设备 IP | Int | Y | 0 | 1：显示（默认） 0：隐藏 | | snShow | 设备序列号 | Int | Y | 0 | 1：显示（默认） 0：隐藏 | | logoShow | Logo显示 | Int | Y | 0 | 1：显示（默认） 0：隐藏 | | opendoorShow | 密码开门显示 | Int | Y | 0 | 1：显示（默认） 0：隐藏 | | logoBase64 | Logo图片的base64数据 | String | N | | 暂未启用 | | bgBase64 | 屏保图片的base64数据 | String | N | | 暂未启用 | postman 示例  返回示例 ```c { "code": "LAN_SUS-0", "msg": "设置成功", "result": 1, "success": true } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2200 | ipShow 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-2201 | snShow 参数异常 | | | 操作正确 | LAN_SUS-0 | 设置成功 | 参数设置成功 | ## 2.7网络配置 请求数据 | Method | URL | |----------|--------------------------------| | POST/GET | http://设备 IP:8060/setNetInfo | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | | ---------- | --------- | ------ | ---- | -------- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | | netType | 网络类型 | Int | Y | 0 | 设备默认为使用以太网，0：以太网，1：WiFi, 2：4g **传入1：设备使用WiFi连接，ssid、pwd参数必须传入且不可为空** | | ssid | | | N/Y | test | | | pwd | | | N/Y | 12345678 | | | isDHCPMod | DHCP | bool | Y | 1 | 设备默认为 DHCP 模式，即自动获取 IP 地址 **传入true**：设备配置为 DHCP 模式，自动获取动态 IP，无须传入其余参数 **传入 false**：自定义网络配置，即手动设置静态IP，ip、gateway、subnetMask、DNS必须传入且不可为空 | | ip | ip 地址 | String | N/Y | | 例：192.168.1.123 | | gateway | 网关 | String | N/Y | | 例：192.168.1.1 | | subnetMask | 子网掩码 | String | N/Y | | 例：255.255.255.0 | | DNS | DNS服务器 | String | N/Y | | 例：114.114.114.114 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2400 | netType参数异常 | 传入参数格式错误或缺少必传参数 | | | LAN_EXP-2402 | ssid 参数异常 | | | | LAN_EXP-2403 | pwd 参数异常 | | | | LAN_EXP-2404 | isDHCPMod 参数不合法 | | | | LAN_EXP-2405 | ip 参数异常 | | | | LAN_EXP-2406 | gateway 参数异常 | | | | LAN_EXP-2407 | dns 参数异常 | | | | LAN_EXP-2408 | subnetMask 参数异常 | | | 操作正确 | LAN_SUS-0 | success | success | ## 2.8设置设备时间 请求数据 | Method | URL | |--------|-----------------------------| | POST | http://设备 IP:8060/setTime | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | | --------- | --------------- | ------ | ---- | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | | timestamp | Unix 秒级时间戳 | Int | Y | | 配置成功后，设备使用该设置时间 ，时间设置成功后，会按照设置的时间增长 ，关闭自动更新时间 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |------------|--------------|----------------------------------------------------------------------------------|--------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数不合法 | LAN_EXP-2500 | timestamp 参数异常 | timestamp 含有非法字符 | | 操作正确 | LAN_SUS-0 | 设置成功。若设备未连入公网，则此时间会生效；若设备连入公网，则会重新使用公网时间 | timestamp 生效后，在局域网内会按照该时间持续增长 | ## 2.9屏幕显示设置 请求数据 | Method | URL | |--------|-------------------------------| | PUT | http://设备 IP:8060/setScreen | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | | --------------------- | ---------------- | ------ | ---- | ------------ | ----------------------------- | | pass | 设备密码 | String | Y | | | | TimeShow | 主界面时间显示 | Int | Y | | 0：关闭，1：打开（默认） | | ScreenTimeShow | 锁屏界面时间显示 | Int | Y | | 0：关闭，1：打开（默认） | | TimeFormat | 时间显示格式 | Int | Y | | 0 ：12 小时 1：24 小时 | | DateFormat | 日期显示格式 | Int | Y | | 0：自动调整（根据时区设置） 1：年月日 2：日月年 3：月日年 | | autoScreenOff | 自动息屏 | Int | Y | | 0：关闭，1：打开（默认） | | autoScreenOffTime | 自动息屏时间 | Int | Y | 默认：300 秒 | | | autoScreenSaverOff | 自动屏保 | Int | Y | | 0：关闭，1：打开（默认） | | autoScreenSaverTime | 自动屏保时间 | Int | Y | 默认：30 秒 | | | autoDisplayBrightness | 自动亮度 | Int | Y | | 0：关闭，1：打开（默认） | | displayBrightness | 显示亮度 | Int | Y | | 屏幕亮度（0~100） | Apipost 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|--------------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2600 | autoScreenOff 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-2601 | autoScreenOffTime 参数异常 | | | | LAN_EXP-2602 | autoScreenSaverOff 参数异常 | | | | LAN_EXP-2603 | autoScreenSaverTime 参数异常 | | | | LAN_EXP-2604 | autoDisplayBrightness 参数异常 | | | | LAN_EXP-2605 | displayBrightness 参数异常 | | | 操作正确 | LAN_SUS-0 | 设置成功 | time 传入值为 0，若设备是识别界面将一直保持屏保 time 传入值为 X，设备待机 X 分钟后进入屏保 | ## 2.10设备重启 请求数据 | Method | URL | |--------|-----------------------------------| | POST | http://设备 IP:8060/restartDevice | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |--------|----------|--------|------|------|----------| | pass | 设备密码 | String | Y | | | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "5秒后重启", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 操作成功，设备即将重启 | pass 正确即可 | ## 2.11设备重置 请求数据 | Method | URL | |----------|----------------------------------| | POST/PUT | http://设备 IP:8060/device/reset | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |--------|----------|--------|------|------|----------| | pass | 设备密码 | String | Y | | | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "设备重置成功，自动重启后生效", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|------------------------------------------------------|----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | 设备禁用中，拒绝此接口 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 操作成功。设备即将清空数据，并将设备配置恢复出厂设置 | | ## 2.12设备禁用/启用 请求数据 | Method | URL | |--------|------------------------------------| | PUT | http://设备 IP:8060/device/disable | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |-----------|----------|---------|------|------|---------------------------------------------------------------------| | pass | 设备密码 | String | Y | | | | isDisable | 是否禁用 | Boolean | Y | | true：禁用， false：解除禁用 禁用界面图片可通过修改禁用图片接口修改 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 设置成功 | | ## 2.13设备升级 请求数据 | Method | URL | |--------|------------------------------------| | PUT | http://设备 IP:8060/device/upgrade | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ------ | ------------------- | ------ | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | type | 升级包类型 | Int | Y | type值强校验，必须为0或1 **0**：升级包为xxx.pkg完整的PKG包升级包较大，适合用于设备整体升级包括（u-boot、kernel、system） **1**：升级包为xxx.tar.xz自定义升级包，升级包较小,内含自定义升级脚本（用来更换配置文件（图片、语音等）、以及应用程序的升级） | | url | 下载 包地址OTA 升级 | String | Y | 调用接口时访问该 url，若 url 能访问到，则设备开始执行下载文件；若 url 访问失败，则接口 返回提示“url 访问失败，设备无法下载”设备开始下载，但文件不一定正确，是否安装成功需要查看设备具体界面 | | md5 | 升级包MD5值 | string | Y | 升级包进行MD5验证 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2700 | url 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-2701 | md5 参数异常 | | | | LAN_EXP-2702 | type 参数异常 | | | 操作正确 | LAN_SUS-0 | 设备即将开始下载 | 设备访问url并尝试下载文件 | ## 2.14设备信息查询 请求数据 | Method | URL | |--------|----------------------------------------| | GET | http://设备 IP:8060/device/information | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |--------|----------|--------|------|------|----------| | pass | 设备密码 | String | Y | | 设备密码 | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|---------|------|---------------------| | data | 设备信息 | Object | Y | 详见\表 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------------|---------------|--------|------|--------------------------| | version | 版本号 | String | Y | 设备系统版本号 | | subVersion | 应用版本号 | String | Y | 应用程序aio的版本号 | | releaseData | 应用发布说明 | String | Y | 目前是日期：如2021/06/30 | | sn | 设备地址(MAC) | String | Y | | | time | 时间 | String | Y | 2021/06/30 当前时间 | | diskTotal | 设备总空间 | Int | Y | 单位 M | | diskUsed | 已用空间 | Int | Y | 单位 M | | diskFree | 剩余空间 | Int | Y | 单位 M | | persionCount | 注册人员数 | Int | Y | | | whiteListCount | 白名单数量 | Int | Y | | | passRecordCount | 通行记录总数 | Int | Y | | | eth0Mac | 以太网mac地址 | String | Y | | | wlan0Mac | 无线mac地址 | String | Y | | | ppp0Mac | 4gmac地址 | String | Y | | Apipost 示例  返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1, "data": { "diskTotal": 5918, "diskUsed": 347, "diskFree": 5570, "version": "v2.0.4rc_r1", "subVersion": "VF203-v1.1.36.3a885-24529?", "releaseData": "2024/05/17 18:00", "sn": "ZBZB666666", "time": "2024/06/11 13:55:19", "persionCount": 2, "whiteListCount": 0, "passRecordCount": 10, "eth0Mac": "1e:e1:12:4c:99:fa", "wlan0Mac": "00:00:00:00:00:00", "ppp0Mac": "00:00:00:00:00:00" } } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 查询成功 | 设备信息查询成功 | ## 2.15摄像头标定 请求数据 | Method | URL | |--------|-------------------------------------| | GET | http://设备 IP:8060/cameraCalibrate | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |---------|----------|--------|------|------|----------| | pass | 设备密码 | String | Y | | 设备密码 | | timeout | 标定超时 | Int | Y | 60 | 单位秒 | postman 示例 返回示例  ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |------------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数不合法 | LAN_EXP-3100 | timeout参数异常 | | | 操作正确 | LAN_SUS-0 | 查询成功 | 设备信息查询成功 | ## 2.16远程控制设备 请求数据 | Method | URL | |--------|------------------------------------| | POST | http://设备 IP:8060/device/control | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | |--------|----------|--------|------|------|----------| | pass | 设备密码 | String | Y | | 设备密码 | | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|---------|------|---------------------| | data | 设备信息 | Object | Y | 详见\表 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | --------- | -------- | ------ | ---- | ------------------------------------------------------------ | | command | 命令参 | Int | Y | 1：开继电器， 2：播报语音，100：重启 | | voiceData | 音频内容 | String | N | 仅在command=2生效 ，中文版传播放文本，外文版上传文件后，不传空即可播放 | postman 示例  返回示例 ```c { "msg": "play voice successe", "code": "LAN_SUS-0", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |------------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 不支持指令 | LAN_EXP-3110 | command Not supported | 不支持指令 | | 参数不正确 | LAN_EXP-3111 | | 某个参数不正确或为空 | | 操作正确 | LAN_SUS-0 | 查询成功 | 设备信息查询成功 | ## 2.17上传语音文件 请求数据 | Method | URL | |--------|--------------------------------| | POST | http://设备 IP:8060/upload/wav | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|-----------------------| | Content-Type | 指定请求的媒体类型 | String | Y | multipart/form-data | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ------ | -------------- | ---- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | file | 上传的音频文件 | File | Y | 自定义语音上传音频文件支持 16 条，每条时长限制 5s 内，命名方式为 cus1.wav- cus16.wav. 人脸核验成功自定义语音内容：cus_face_succ.wav 人脸核验失败自定义语音内容：cus_face_fail.wav 刷卡核验成功自定义语音内容：cus_nfc_succ.wav 刷卡核验失败自定义语音内容：cus_nfc_fail.wav 扫码核验成功自定义语音内容：cus_qr_succ.wav 扫码核验失败自定义语音内容：cus_qr_fail.wav | 返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------------|--------------|----------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1004 | 设备已禁用 | | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | 文件保存失败 | LAN_EXP-3101 | 文件保存失败 | 文件保存失败 | | 文件内容不正确 | LAN_EXP-3102 | 非音频文件 | 上传内容不对 | | 表单解析失败 | LAN_EXP-3103 | 解析表单失败 | 解析表单失败 | | | | | | | 操作正确 | LAN_SUS-0 | 成功 | 成功 | # 三、人员管理类接口 ## 3.1人员注册 请求数据 | Method | URL | |--------|-----------------------------------| | POST | http://设备 IP:8060/person/create | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ---------------------------- | ---------------- | ---------- | ----- | ------------------------------------------------------------------------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | employeeNumber | 人员 Id | String | Y | 员工号，E.g SW200 | | name | 人员名称 | String | Y | name 参数必传且内容不可为空。长度、内容无限制。 | | ~~gender~~ | ~~性别~~ | ~~String~~ | ~~N~~ | ~~Gender(E.g "Man/Women/..." )~~ | | ~~nationa~~ | ~~国家~~ | ~~String~~ | ~~N~~ | | | departmentName | 部门名称 | String | N | | | idCardNumber | 人员卡号 | String | N | 注册时可以不填，长度、内容无限制。若注册人员时填写了卡号，可直接刷对应卡号的卡进行识别，屏幕也会显示与该卡号对应的人员的名字。 | | ~~mobile~~ | ~~手机号~~ | ~~String~~ | ~~N~~ | ~~人员手机号~~ | | ~~accessRight~~ | ~~权限模式~~ | ~~Int~~ | ~~N~~ | ~~0：自由通行 1：临时通行，模式 1 2：临时通行模式 2~~ | | ~~temporaryAccessStartTime~~ | ~~开始时间戳~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 1~~ | | ~~temporaryAccessEndTime~~ | ~~结束时间戳~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 1~~ | | ~~temporaryAccessTimes~~ | ~~通行次数~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 2~~ | | ~~accessCardNumber~~ | ~~门禁卡号~~ | ~~String~~ | ~~N~~ | ~~门禁卡号，识别模式为刷卡时有效~~ | | ~~remarks~~ | ~~备注~~ | ~~String~~ | ~~N~~ | ~~用于填写说明信息~~ | | photoFromCapture | 拍照注册 | Int | N | 1：拍照注册 | | replace | 替换标志 | Int | N | 1：若员工号已注册则替换 | | registerBase64 | 照片 base64 数据 | String | Y/N | 注册人员的 Base64 图片，当 photoFromCapture = 1 时可不传，当 photoFromCapture != 1 时为必传项 | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` - 注意：姓名、卡号注册成功，实际上是人员信息写入设备数据库。若使用设备读取卡号进行注册，实际上是先读取卡号，再将卡号写入数据库，因此与注册人员时直接填写卡号效果一样 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3000 | employeeNumber 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3001 | name 参数异常 | | | | LAN_EXP-3002 | registerBase64 参数异常 | | | 注册异常 | LAN_EXP-3003 | employeeNumber 已被占用 | 人员ID已经注册 | | | LAN_EXP-3004 | registerBase64 数据错误 | 非base64编码数据 | | | LAN_EXP-3005 | registerBase64 图片错误 | 图片脸部特征过低，人脸库存在相似度过高的图片等 | | | LAN_EXP-3006 | 拍照注册中 | 上次注册未完成 | | 操作正确 | LAN_SUS-0 | 人员信息添加成功 | 人员信息成功写入数据库确 | ## 3.2人员删除 请求数据 | Method | URL | |--------|-----------------------------------| | POST | http://设备 IP:8060/person/delete | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | -------------- | -------- | ------ | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | employeeNumber | 人员 ID | String | Y | 若删除多个人员， id 用英文逗号拼接 传入-1 则删除所有人员 • 以下数据会被删除，本地将不再做存储： 该人员 ID、人员信息 、该人员对应的识别记录、现场抓拍照片 该人员对应的注册照片 • **人员 ID(id)只允许数字-1， 0\~9 和英文字母， 且最大长度为 255** | postman 示例  返回示例： ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明 | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3000 | employeeNumber 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | 操作正确 | LAN_SUS-0 | 删除成功 | 成功删除指定的 id | ## 3.3人员查询 请求数据 | Method | URL | |--------|---------------------------------| | GET | http://设备 IP:8060/person/find | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | -------------- | ------------ | ------ | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | picLarge | 注册时的照片 | Int | N | 是否返回注册时照片，0或者不传不返回，1：返回 | | employeeNumber | 人员 ID | String | N | • 查询指定 id 的人员信息 • id 传入-1 表示不局限于 id 查询人员 | | name | 人员姓名 | String | N | 当name不存在时表示不局限于name 查询人员 | | length | 每页最大数量 | int | Y | 返回图片范围(0,100],不返回图片(0,1000] | | index | 页码 | int | Y | 页码，从 0 开始。 index 的传入值必须小于总页码数，如：总页码数为 1， index 只能传入 0 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-------------|------------------|---------|------|---------------------------| | personInfos | 是否设置接口密码 | Array | Y | 详见\表 | | pageInfo | 查询页数据 | Object | Y/N | 详见\表 | personInfos数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------------------|------------|--------|------|----------------| | employeeNumber | 人员ID | String | Y | | | name | 人员姓名 | String | Y | | | gender | 性别 | String | N | | | nationa | 国家 | String | N | | | departmentName | 部门名称 | String | N | | | idCardNumber | 人员卡号 | String | N | | | mobile | 手机号 | String | N | | | accessRight | 权限模式 | Int | N | | | temporaryAccessStartTime | 开始时间戳 | Int | N | | | temporaryAccessEndTime | 结束时间戳 | Int | N | | | temporaryAccessTimes | 通行次数 | Int | N | | | accessCardNumber | 门禁卡号 | String | N | | | remarks | 备注 | String | N | | | picBase64 | 注册照片 | String | Y | Base64照片数据 | pageInfo数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------|------------|------|------|----------------| | index | 当前页 | Int | Y | | | length | 每页大小 | Int | Y | | | total | 总数 | Int | Y | | | totalPage | 总页数 | Int | Y | Base64照片数据 | | size | 当前页大小 | Int | Y | | postman 示例  返回示例： ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1, "data": { "personInfos": [ { "employeeNumber": "123456", "name": "常永彬", "idCardNumber": "9876543210" } ], "pageInfo": { "index": 0, "length": 10, "size": 1, "total": 1 } } } ``` 返回说明 | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3016 | length 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3017 | index 参数异常 | | | 操作正确 | LAN_SUS-0 | 查询成功 | 查询操作成功 | ## 3.4人员更新 请求数据 | Method | URL | |--------|-----------------------------------| | POST | http://设备 IP:8060/person/update | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ------------------------ | -------------- | ------ | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | employeeNumber | 人员 Id | String | Y | 员工号（**人员id不可修改**） | | name | 人员名称 | String | Y | name 参数必传且内容不可为空。长度、内容无限制。 | | gender | 性别 | String | N | Gender(E.g "Man/Women/..." ) | | nationa | 国家 | String | N | | | departmentName | 部门名称 | String | N | | | idCardNumber | 人员卡号 | String | N | 更新时可以不填，长度、内容无限制。若注册人员时填写了卡号，可直接刷对应卡号的卡进行识别，屏幕也会显示与该卡号对应的人员的名字。 | | mobile | 手机号 | String | N | 人员手机号 | | accessRight | 权限模式 | Int | N | 0：自由通行 1：临时通行，模式1 2：临时通行模式2 | | temporaryAccessStartTime | 开始时间戳 | Int | N | 对应临时通行模式1 | | temporaryAccessEndTime | 结束时间戳 | Int | N | 对应临时通行模式1 | | temporaryAccessTimes | 通行次数 | Int | N | 对应临时通行模式2 | | accessCardNumber | 门禁卡号 | String | N | 门禁卡号，识别模式为刷卡时有效 | | remarks | 备注 | String | N | 用于填写说明信息 | | registerBase64 | 照片base64数据 | String | N | 更新人员的Base64图片 | | | | | | | 返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3000 | employeeNumber 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3001 | name 参数异常 | | | | LAN_EXP-3002 | registerBase64 参数异常 | | | 注册异常 | LAN_EXP-3003 | employeeNumber 已被占用 | 人员ID已经注册 | | | LAN_EXP-3004 | registerBase64 数据错误 | 非base64编码数据 | | | LAN_EXP-3005 | registerBase64 图片错误 | 图片脸部特征过低，人脸库存在相似度过高的图片等 | | | LAN_EXP-3006 | 拍照注册中 | 上次注册未完成 | | 操作正确 | LAN_SUS-0 | 人员信息添加成功 | 人员信息成功写入数据库确 | ## 3.5同步白名单 请求数据 | Method | URL | |--------|------------------------------------------| | POST | http://设备 IP:8060/person/whiteListSync | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |------------|------------|--------|------|------------------------| | pass | 设备密码 | String | Y | | | syncFlag | 同步标识 | Int | Y | 1-全量，2-增量 | | whiteLists | 白名单数组 | Array | Y | 白名单Json数组详见下表 | whiteLists数组，数组大小**最好控制在1000以内**，单个元素为Object类型，参数如下 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------------|--------------|--------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | userType | 用户类型 | Int | Y | 101-二维码，202-卡，303-人脸 | | userId | 用户ID | String | Y | | | beginTime | 开始时间 | Int | N | 时间戳，单位秒 eg: 1640917147 表示：2021-12-31 10:19:07 小于等于0则不限制开始时间 | | endTime | 结束时间 | Int | N | 时间戳，单位秒 小于等于0则不限制结束时间 | | repeatType | 重复类型 | Int | N | 小于等于0-不重复，1-每天重复，4-每周重复，3-每月重复 | | repeatBeginTime | 重复开始时间 | Int | N/Y | repeatType=1：开始时间为距0点的时间，范围[0,86400]，eg:28800表示当天8点，必传 repeatType=2：开始时间为周几，eg: 0-星期天，1-周一，2-周二 … 取值[0, 6]，必传 repeatType=3：开始时间为某日，取值[1, 31]，必传 | | repeatEndTime | 重复结束时间 | Int | N/Y | repeatType=1：结束时间为距0点的时间，范围[0,86400]，eg:28800表示当天8点，必传 repeatType=2：结束时间为周几，eg: 0-星期天，1-周一，2-周二 … 取值[0, 6]，必传 repeatType=3：结束时间为某日，取值[1, 31]，必传 | | weekPeriodTime | 周重复规则 | Object | N/Y | repeatType=4：周重复规则，必传，规则见下表 | | syncType | 同步类型 | Int | Y | 当syncFlag=2时有效，1-增加，2-修改，3-删除（当为删除时，如果beginTime, endTime\<=0，则删除所有符合要求的，不忽略userType、userId；如beginTime\>=0，则增加条件开始时间\>=beginTime，并匹配userType与userId;如endTime\>= 0，则增加条件结束时间\<=endTime，并匹配userType与userId） | weekPeriodTime参数如下，每天的时间格式为："**HH:MM-HH:MM"，24小时制时分**，Eg："08:00-18:30"。**周1\~7至少有一天为必传** | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|------|--------|------|-------------------------------------------------------| | 1 | 周一 | String | N/Y | 无此项代表周一无权限，"00:00-24:00"：代表周一全天有效 | | 2 | 周二 | String | N/Y | 同上 | | 3 | 周三 | String | N/Y | 同上 | | 4 | 周四 | String | N/Y | 同上 | | 5 | 周五 | String | N/Y | 同上 | | 6 | 周六 | String | N/Y | 同上 | | 7 | 周日 | String | N/Y | 同上 | postman 示例 ```c { "pass": "123456", "syncFlag": 1, "whiteLists": [ { "userType": 202, "userId": "cdb332be", "beginTime": 1640917147, "endTime": 1672453147, "repeatType": 0, "repeatBeginTime": 0, "repeatEndTime": 0, "syncType": 1 }, { "userType": 101, "userId": "412725202101011234", "beginTime": 1640917147, "endTime": 1672453147, "repeatType": 0, "repeatBeginTime": 0, "repeatEndTime": 0, "syncType": 1 } ] } ``` 返回示例 ```c { "msg": "success", "code": "LAN_SUS-0", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3010 | whiteLists白名单数组错误 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3011 | syncFlag 参数错误 | | | | LAN_EXP-3012 | userType 参数错误 | | | | LAN_EXP-3013 | userId 人员ID参数错误 | | | | LAN_EXP-3014 | syncType 参数错误 | | | 操作正确 | LAN_SUS-0 | 人员信息添加成功 | 人员信息成功写入数据库确 | ## 3.6查询白名单 请求数据 | Method | URL | |--------|------------------------------------------| | POST | http://设备 IP:8060/person/whiteListFind | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------|--------------|--------|------|---------------------------------------------------------------------------------------| | pass | 设备密码 | String | Y | | | userType | 用户类型 | Int | N | 101-二维码，202-卡，303-人脸 | | userId | 用户ID | String | N | | | beginTime | 开始时间 | Int | N | 若存在且大于0，则只查找 \>= beginTime | | endTime | 结束时间 | Int | N | 若存在且大于0，则只查找 \<= endTime | | length | 每页最大数量 | Int | Y | (0,1000] | | index | 页码 | Int | Y | 页码，从 0 开始。 index 的传入值必须小于总页码数，如：总页码数为 1， index 只能传入 0 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |------------|------------|---------|------|---------------------------| | pageInfo | 查询页数据 | Object | Y | 详见\表 | | whiteLists | 白名单数组 | Array | Y/N | 详见\< whiteLists数据\>表 | pageInfo数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------|------------|------|------|--------------------| | index | 当前页 | Int | Y | 当前页 | | length | 每页大小 | Int | Y | 当前页大小 | | total | 总数 | Int | Y | 白名单总数 | | totalPage | 总页数 | Int | Y | 总页数 | | size | 当前页大小 | Int | Y | 当前页实际白名单数 | whiteLists数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------------|--------------|--------|------|----------| | userType | 人员类型 | Int | Y | | | userId | 人员ID | String | Y | | | beginTime | 开始时间 | Int | Y | | | endTime | 结束时间 | Int | Y | | | repeatType | 重复类型 | Int | Y | | | repeatBeginTime | 重复开始时间 | Int | Y | | | repeatEndTime | 重复结束时间 | Int | Y | | postman 示例  返回示例： ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1, "data": { "pageInfo": { "index": 0, "length": 20, "total": 1, "totalPage": 1, "size": 1 }, "whiteLists": [ { "userType": 202, "userId": "cdb332be", "beginTime": 1640917147, "endTime": 1672453147, "repeatType": 0, "repeatBeginTime": 0, "repeatEndTime": 0 } ] } } } ``` 返回说明 | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3016 | length 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3017 | index 参数异常 | | | 操作正确 | LAN_SUS-0 | 查询成功 | 查询操作成功 | ## 3.7人员注册（feature） 请求数据 | Method | URL | |--------|------------------------------------------| | POST | http://设备 IP:8060/person/registerFeats | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|--------|------|----------------------| | pass | 设备密码 | String | Y | | | users | 人员数组 | Array | Y | 人员Json数组详见下表 | data数组，数组大小最好控制在500(1M左右)以内，单个元素为Object类型，参数如下 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | | ---------------------------- | -------------- | ---------- | ----- | ------------------------------------------------------------------------------------------------------------------------------ | | employeeNumber | 人员信息集合 | Array | Y | 员工号，E.g SW200 | | name | 人员名称 | String | Y | name 参数必传且内容不可为空。长度、内容无限制。 | | feature | 特征值 | String | Y | 人员特征值 16 进制字符串长度 2048 字节 | | ~~gender~~ | ~~性别~~ | ~~String~~ | ~~N~~ | ~~Gender(E.g "Man/Women/..." )~~ | | ~~nationa~~ | ~~国家~~ | ~~String~~ | ~~N~~ | | | departmentName | 部门名称 | String | N | | | idCardNumber | 人员卡号 | String | N | 注册时可以不填，长度、内容无限制。若注册人员时填写了卡号，可直接刷对应卡号的卡进行识别，屏幕也会显示与该卡号对应的人员的名字。 | | ~~mobile~~ | ~~手机号~~ | ~~String~~ | ~~N~~ | ~~人员手机号~~ | | ~~accessRight~~ | ~~权限模式~~ | ~~Int~~ | ~~N~~ | ~~0：自由通行 1：临时通行，模式 1 2：临时通行模式 2~~ | | ~~temporaryAccessStartTime~~ | ~~开始时间戳~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 1~~ | | ~~temporaryAccessEndTime~~ | ~~结束时间戳~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 1~~ | | ~~temporaryAccessTimes~~ | ~~通行次数~~ | ~~Int~~ | ~~N~~ | ~~对应临时通行模式 2~~ | | ~~accessCardNumber~~ | ~~门禁卡号~~ | ~~String~~ | ~~N~~ | ~~门禁卡号，识别模式为刷卡时有效~~ | | ~~remarks~~ | ~~备注~~ | ~~String~~ | ~~N~~ | ~~用于填写说明信息~~ | | replace | 替换标志 | Int | N | 1：若员工号已注册则替换 | postman 示例  返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1, "data": 0 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3000 | employeeNumber 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3001 | name 参数异常 | | | 注册异常 | LAN_EXP-3003 | employeeNumber 已被占用 | 人员ID已经注册 | | | LAN_EXP-3018 | users 参数异常 | | | 操作正确 | LAN_SUS-0 | 人员信息添加成功 | 人员信息成功写入数据库确 | ## 3.8密码权限注册（支持密码开门才有） 添加姓名后设备会自动申请一个随机的密码 请求数据： | Method | URL | |--------|---------------------------------------| | POST | http://设备 IP:8060 /userpassword/add | Header域： | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域： | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|--------|------|------------| | pass | 设备密码 | String | Y | | | name | 人员名称 | String | Y | 密码所有者 | postman 示例  返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1, "data": "123456" } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3001 | name 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | 操作正确 | | | 信息成功写入数据库 | ## 3.9密码权限查询 请求数据 | Method | URL | |--------|---------------------------------------| | GET | http://设备 IP:8060/userpassword/find | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|--------|------|------------| | pass | 设备密码 | String | Y | | | name | 人员姓名 | String | Y | 密码所有者 | postman 示例  返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1, "data": { "count": 2, "password": ["128452", "848648"] ] } } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|-----------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进程中 | | | LAN_EXP-1006 | XX method is not supported. | Method与url不匹配 | | 参数异常 | LAN_EXP-3001 | name 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | 操作正确 | | | 信息成功写入数据库 | ## 3.10密码权限删除 请求数据： | Method | URL | |--------|---------------------------------------| | POST | http://设备 IP:8060 /userpassword/del | Header域： | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域： | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |----------|----------|--------|------|--------------------------------------------| | pass | 设备密码 | String | Y | | | name | 人员名称 | String | N | 删除的人员姓名（删除这个人名下的所有密码） | | password | 密码权限 | String | N | 删除的密码（名字和密码都为空删除所有） | 返回示例 ```c { "msg": "成功", "code": "LAN_SUS-0", "success": true, "result": 1 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|-----------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-2001 | 删除失败/清空失败 | 缺少条件或没有相关数据 | | | LAN_EXP-2002 | 没有符合条件的权限 | 数据库没有条件的权限 | | | | | | | 操作正确 | | | 信息成功写入数据库 | # 四、识别记录 ## 4.1识别记录删除 请求数据 | Method | URL | |--------|-----------------------------------| | POST | http://设备 IP:8060/deleteRecords | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 默认 | 附加说明 | | -------------- | ------------ | ------ | ---- | ---- | ------------------------------------------------------------ | | pass | 设备密码 | String | Y | | | | employeeNumber | 人员 ID | String | N | | 传入非空删除指定employeeNumber 传入""或不传，删除所有 | | startTime | 记录开始时间 | Int | N | | 传入大于0的数删除startTime之后的记录 传入小于等于0或不传删除所有 | | endTime | 记录结束时间 | Int | N | | 传入大于0的数删除endTime之前的记录 传入小于等于0或不传删除所有 | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|------|------|----------| | data | 删除数目 | Int | Y | | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1, "data": 7 //删除的数量 } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|-----------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 操作正确 | LAN_SUS-0 | 删除成功 | 成功删除识别记录和现场照 | ## 4.2识别记录查询 请求数据 | Method | URL | |--------|---------------------------------| | GET | http://设备 IP:8060/findRecords | Header域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------------|--------------------|--------|------|------------------| | Content-Type | 指定请求的媒体类型 | String | Y | application/json | Body域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |----------------|--------------|--------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | pass | 设备密码 | String | Y | | | employeeNumber | 人员 ID | String | N | 查询指定 id 的人员识别记录 传入-1 可查询所有人员的识别记录，包括陌生人 传入 STRANGERBABY，可查询所有陌生人/识别失败记录 传入 IDCARD，可查询所有人证比对的记录 | | picLarge | 识别时的照片 | Int | N | 是否返回识别时照片，0或者不传不返回，1：返回 | | name | 人员姓名 | String | N | 当name不存在时表示不局限于name 查询 | | startTime | 记录开始时间 | Int | N | 若不按时间查询，不传此项 若需要按时间查询，传入时间戳 | | endTime | 记录结束时间 | Int | N | 若不按时间查询，不传此项 若需要按时间查询，传入时间戳 | | length | 页大小 | Int | Y | 返回图片范围(0,100],不返回图片(0,1000] | | index | 页码 | Int | Y | 页码，从 0 开始 | ans域 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |--------|----------|---------|------|---------------------| | data | 识别记录 | Object | Y | 详见\表 | Data 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |----------|------------------|---------|------|------------------------| | records | 是否设置接口密码 | Array | Y | 详见\表 | | pageInfo | 查询页数据 | Object | Y/N | 详见\表 | records 数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |----------------|------------|--------|------|----------------------------------------------------------------------------------------| | employeeNumber | 人员ID | String | Y | | | name | 人员姓名 | String | Y | | | timeStamp | 通行时间戳 | Int | Y | | | temperature | 温度 | Int | N | 开启测温时后可查 | | result | 通行结果 | Int | Y | 0：成功，其他失败 | | message | 错误描述 | String | Y | 通行信息 | | picBase64 | 通行照片 | String | Y | Base64照片数据 | | baseData | 基础数据 | String | Y | 记录不同识别模式下，一些详细的基础数据（如识别类型，id，身份证信息，时间，设备序列号） | pageInfo数据 | 参数名 | 描述 | 类型 | 必传 | 附加说明 | |-----------|------------|------|------|----------| | index | 当前页 | Int | Y | | | length | 每页大小 | Int | Y | | | total | 总数 | Int | Y | | | totalPage | 总页数 | Int | Y | | | size | 当前页大小 | Int | Y | | postman 示例  返回示例 ```c { "msg": "LAN_SUS-0", "code": "success", "success": true, "result": 1, "data": { "records": [{ "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622001688, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622080027, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622081502, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622090347, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622274645, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622423014, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622431548, "picBase64": "" }, { "employeeNumber": "123456", "name": "常永彬", "timeStamp": 1622441204, "picBase64": "" }], "pageInfo": { "index": 0, "length": 10, "total": 8, "totalPage": 1, "size": 8 } } } ``` 返回说明： | 类型 | Code | msg | 触发原因 | |----------|--------------|---------------------------------|--------------------------------------------------------------------------------------| | 通用报错 | LAN_EXP-1000 | 未知错误 | 未知错误 | | | LAN_EXP-1001 | 密码参数异常 | 密码参数异常 | | | LAN_EXP-1002 | 密码错误 | 密码错误 | | | LAN_EXP-1003 | 未设置密码 | 未设置密码 | | | LAN_EXP-1005 | 设备正忙，请稍后再试 | 设备正在升级、设置网络或其他任务进 程中 | | | LAN_EXP-1006 | The XX method is not supported. | Method 与 url 不匹配 | | 参数异常 | LAN_EXP-3016 | length 参数异常 | 参数名拼写错误、参数漏传、参数在请求中的位置不正确、参数名带有空格或回车、参数值异常 | | | LAN_EXP-3017 | index 参数异常 | | | 操作正确 | LAN_SUS-0 | 查询成功 | 查询操作成功 | # 附表 1 Code 码总览 | Code码 | msg | | ------------------- | ------------------------------------------------------------ | | 通用错误码 | | | LAN_SUS-0 | 接口调用成功， msg 随接口不同而不同 | | LAN_EXP-1000 | 未知异常 | | LAN_EXP-1001 | 密码参数异常 | | LAN_EXP-1002 | 密码错误 | | LAN_EXP-1003 | 接口服务未设置密码，请先设置密码 | | LAN_EXP-1004 | 设备已被禁用，请先启用再做其它操作 | | LAN_EXP-1005 | 设备正忙，请稍后再试 | | LAN_EXP-1006 | The XX method is not supported. | | LAN_EXP-1007 | 请求body错误 | | LAN_EXP-1008 | json格式错误 | | LAN_EXP-1009 | 保存数据出错 | | 设置密码 | | | LAN_EXP-2000 | oldPass不合法 | | LAN_EXP-2001 | newPass不合法 | | LAN_EXP-2002 | oldPass != newPass | | LAN_EXP-2003 | oldPass错误 | | 禁用设备 | | | LAN_EXP-2100 | isDisable参数不合法 | | 隐藏 IP、设备序列号 | | | LAN_EXP-2200 | ipShow 参数异常 | | LAN_EXP-2201 | snShow 参数异常 | | 设备序列号获取 | | | LAN_EXP-2300 | 读取SN失败 | | 网络配置 | | | LAN_EXP-2400 | en 参数异常 | | ~~LAN_EXP-2401~~ | ~~wifiMsg 参数异常~~ | | LAN_EXP-2402 | ssid 参数异常 | | LAN_EXP-2403 | pwd 参数异常 | | LAN_EXP-2405 | ip 参数异常 | | LAN_EXP-2406 | gateway 参数异常 | | LAN_EXP-2407 | dns 参数异常 | | LAN_EXP-2408 | subnetMask 参数异常 | | 设置设备时间 | | | LAN_EXP-2500 | timestamp 参数异常 | | 屏幕显示设置 | | | LAN_EXP-2600 | autoScreenOff 参数异常 | | LAN_EXP-2601 | autoScreenOffTime 参数异常 | | LAN_EXP-2602 | autoScreenSaverOff 参数异常 | | LAN_EXP-2603 | autoScreenSaverTime 参数异常 | | LAN_EXP-2604 | autoDisplayBrightness 参数异常 | | LAN_EXP-2605 | displayBrightness 参数异常 | | 设备升级 | | | LAN_EXP-2700 | url 参数异常 | | LAN_EXP-2701 | md5 参数异常 | | 设备配置 | | | LAN_EXP-2800 | config 参数异常 | | 照片注册 | | | LAN_EXP-3000 | employeeNumber 参数异常 | | LAN_EXP-3001 | name 参数异常 | | LAN_EXP-3002 | registerBase64 参数异常 | | LAN_EXP-3003 | employeeNumber 已被占用 | | LAN_EXP-3004 | registerBase64 非base64编码数据 | | LAN_EXP-3005 | registerBase64 图片注册失败,常见错误有：图片脸部特征过低，人脸库存在相似度过高的图片等 | | LAN_EXP-3006 | 拍照注册，上次拍照注册未完成 | | 白名单 | | | LAN_EXP-3010 | whiteLists白名单数组错误 | | LAN_EXP-3011 | syncFlag 白名单同步标识错误 | | LAN_EXP-3012 | userType 人员类型参数错误 | | LAN_EXP-3013 | userId 人员ID参数错误 | | LAN_EXP-3014 | syncType 同步类型参数错误 | | LAN_EXP-3015 | 全量更新，清空白名单失败 | | LAN_EXP-3016 | length 参数异常,有效范围(0,1000] | | LAN_EXP-3017 | index 参数异常,范围[0, \~] | | 摄像头标定 | | | LAN_EXP-3100 | timeout 参数异常 | | 上传音频文件 | | | LAN_EXP-3101 | 音频文件保存失败 | | LAN_EXP-3102 | 无此文件 | # 附表 2 可用时区列表 | 国家/地区及城市 | 时区 | | ----------------- | ------------------- | | 澳大利亚/悉尼 | Australia/Sydney | | 加拿大/多伦多 | America/Toronto | | 中国/北京 | Asia/Shanghai | | 德国/柏林 | Europe/Berlin | | 中国/香港 | Asia/Hong_Kong | | 日本/东京 | Asia/Tokyo | | 中国/澳门 | Asia/Macau | | 欧洲/马耳他 | Europe/Malta | | 新加坡 | Asia/Singapore | | 韩国/首尔 | Asia/Seoul | | 中国/台湾 | Asia/Taipei | | 英国/伦敦 | Europe/London | | 美国/纽约 | America/New_York | | 巴西/圣保罗 | America/Sao_Paulo | | 法国/巴黎 | Europe/Paris | | 墨西哥/墨西哥城 | America/Mexico_City | | 西班牙/马德里 | Europe/Madrid | | 阿联酋/迪拜 | Asia/Dubai | | 沙特阿拉伯/利雅得 | Asia/Riyadh | | 卡塔尔 | Asia/Qatar | | 瑞士/苏黎世 | Europe/Zurich | | 俄罗斯/莫斯科 | Europe/Moscow | # 修订记录 | 版本 | 修改日期 | 修改人 | 修改内容 | | ------- | ---------- | ------ | ------------------------------------------------------------ | | V1.0.0 | 2021/05/25 | 常永彬 | 新建文档 | | V1.0.1 | 2021/06/10 | 常永彬 | 修改《设备升级接口》，增加升级类型type，详见接口参数type的附加说明 | | V1.0.2 | 2021/06/23 | | 《设备配置》增加人脸识别数配置maxTrackFaces，最多支持5人 | | V1.0.3 | 2021/06/30 | | 增加Web Server 登录/修改密码接口 | | V1.0.4 | 2021/07/02 | | 补充《人员注册》接口参数 | | V1.0.5 | 2021/07/05 | | 补充《设备信息查询》接口参数 | | V1.0.6 | 2021/07/14 | | 补充《设备配置》接口 | | V1.0.7 | 2021/07/20 | | 补充《设备配置查询》接口 | | V1.0.8 | 2021/07/28 | | 修改《人员注册》接口错误码 | | V1.0.9 | 2021/07/31 | | 补充《设备配置接口》漏写的配置 | | V1.0.10 | 2021/08/19 | | 《人员查询》和 《识别记录查询》增加姓名查找 | | V1.0.11 | 2021/08/20 | | 《人员注册》增加拍照注册选项 | | V1.0.12 | 2021/09/18 | | 《设备配置》增加人员注册阈值设置 | | V1.0.13 | 2021/09/22 | | 《识别记录查询》增加返回识别照片标志 | | V1.0.14 | 2021/12/15 | | 《设备配置》《设备配置查询》增加MQTT配置 《人员注册》增加是否替换标志 | | V1.0.15 | 2022/01/13 | | 增加《同步白名单》、《查询白名单》 （scannerWorkMode、faceWorkMode）增加本地白名单模式，增加onlineCheck字段 通行记录增加两个字段 | | V1.0.16 | 2022/2/07 | | 修改《设备配置》增加mqttTopicPrefix、mqttMessageQos字段 | | V1.0.17 | 2022/4/11 | | 完善《人员注册》、《人员查询》 | | V1.0.18 | 2022/5/05 | | 《设备配置》增加读取身份证号配置（nfcReadIdNum）、增加自定义配置（cusTag0\~cusTag9） | | V1.0.19 | 2022/7/14 | | 增加人员特征值注册 增加人证比对阈值配置 | | V1.0.20 | 2022/9/22 | | 增加识别记录查询功能返回的测温项 | | V1.0.21 | 2022/10/20 | 刘胜义 | 1. 增加远程控制设备 | | V1.0.22 | 2022/11/14 | | 1、2.6增加logo隐藏及显示 | | V1.0.23 | 2023/03/15 | | 1. 新增白名单通行规则 | | V1.0.24 | 2023/3/17 | 唯义 | 添加配置字段身份证详细（设备配置） | | V1.0.25 | 2024/6/11 | 赵旭龙 | 2.3设备序列号获取修改错误 2.4设备配置增加密码开门配置 2.5设备配置查询增加密码开门配置查询 2.6隐藏ip，设备序列号，logo更新 2.7网络配置更新 2.9屏幕显示设置更新 2.14设备信息查询更新 2.15摄像头标定更错 3.9密码权限删除更新 | | V1.0.25 | 2024/6/12 | 赵旭龙 | 增加密码开门开关 | | V1.0.26 | 2024/9/29 | 赵旭龙 | 1.删除自动更新时区字段2.更新时区表3.更新自定义语音字段4.更新语言字段5. 更新配置里陌生人语音，语音模式，问候语备注6.增加人员更新接口7.更新设置时间说明8.增加上传语音接口 | | V1.0.26 | 2024/10/11 | 赵旭龙 | 增加继电器工作方式配置字段 | | V1.0.27 | 2024/10/22 | 赵旭龙 | 1.增加SA100相关字段 2.更新语言字段 3.更新上传语音包字段 4.更新设备控制语音字段 5.更新时区字段 6.增加时间和日期显示格式字段 7.增加云证长度配置字段 8.校验配置字段 | | V1.0.28 | 2024/10/30 | 赵旭龙 | 1.更新人员注册接口字段 | | V1.0.28 | 2024/11/01 | 赵旭龙 | 1.增加NTP服务地址配置 |
石磊
2025年5月29日 16:00
3
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
Word文件
PDF文档
PDF文档（打印）
分享
链接
类型
密码
更新密码
有效期