人脸识别相机ME100 CGI接口文档
- 更新记录
- /webapi/system/login
- /webapi/system/edit/passwd
- /webapi/system/status
- /webapi/system/time/set
- /webapi/system/time/get
- /webapi/net/eth/set
- /webapi/net/eth/get
- /webapi/net/wifi/set
- /webapi/net/wifi/get
- /webapi/net/dns/set
- /webapi/net/dns/get
- /webapi/device/info
- /webapi/record/query/tem
- /webapi/tem/threshold/set
- /webapi/tem/threshold/get
- /webapi/tem/calibration/set
- /webapi/tem/calibration/get
- /webapi/tem/mode/set
- /webapi/webhook/get
- /webapi/webhook/set
- /webapi/webhook/test
- /webapi/system/reset
- /webapi/tem/record/clear/get
- /webapi/tem/record/clear/set
- /webapi/gpio/set
- /webapi/gpio/get
- /webapi/gpio/test
- /webapi/rtmplive/set
- /webapi/rtmplive/get
- /webapi/rtmplive/test
- /webapi/log/system
- /webapi/sound/status/set
- /webapi/sound/status/get
- /webapi/screen_savers/status/set
- /webapi/screen_savers/status/get
- /webapi/screen_savers/upload
- /webapi/screen_savers/delete
- /webapi/record/export
- /webapi/record/clear
- /webapi/record/get/save/state
- /webapi/record/set/save/state
- /webapi/system/time/format/set
- /webapi/system/time/format/get
- /webapi/member/register
- /webapi/member/device/register
- /webapi/member/remove
- /webapi/member/clear
- /webapi/member/query
- /webapi/member/edit
- /webapi/member/access/date
- /webapi/use/mode/get
- /webapi/use/mode/set
- /webapi/white/light/get
- /webapi/white/light/set
更新记录
2021-08-27 (V1.1.3)
序号 | 内容 | 接口 |
---|---|---|
1 | 添加人脸注册图片格式说明 | /webapi/member/register |
2021-08-23 (V1.1.2)
序号 | 内容 | 接口 |
---|---|---|
1 | 添加门禁访问时间 | /webapi/member/access/date |
2 | 获取人脸信息接口增加访问时间 | /webapi/member/query |
/webapi/system/login
登录接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
返回值code, 0:成功,负数:失败
json
{
"code": 0
}
例:
http://192.168.102.52/webapi/system/login?user=admin&passwd=admin
/webapi/system/edit/passwd
修改登录密码
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
new_passwd | 新密码 |
返回值code, 0:成功,负数:失败
{
"code": 0
}
例:
http://192.168.102.52/webapi/system/edit/passwd?user=admin&passwd=admin&new_passwd=123456
/webapi/system/status
获取系统状态
返回参数
device 数组的参数
字段 | 描述 |
---|---|
model | 设备型号 |
app_version | app版本号 |
root_version | 文件系统版本号 |
sys_version | 操作系统版本号 |
sys 数组的参数
字段 | 描述 |
---|---|
uptime | 设备从开机到现在经过的时间,单位秒 |
loads[3] | 数组,三个元素,分别表示1,5,15分钟内的平均负载 |
totalram | 总内存,单位byte |
freeram | 可用内存,单位byte |
bufferram | 缓冲内存,单位byte |
返回值
{
"device": {
"app_version": "1.0.0.1",
"model": "JFG-KQJ",
"root_version": "1.0.0.999",
"sys_version": "Linux (none) 3.10.103",
"tfcard_total" : 1,
"tfcard_free" : 1
},
"sys": {
"bufferram": 2936832,
"freeram": 2166784,
"loads": [
1.1484375,
0.3564453125,
0.12451171875
],
"totalram": 58322944,
"uptime": 71
}
}
例:
/webapi/system/time/set
设置设备时间
参数
字段 | 描述 |
---|---|
time | 设备当前的utc时间,单位:秒。 |
time_zone | 设备当前时区,单位:秒,时区3600。如北京时区:83600=28800。 |
ntp_enable | ntp校时开关, 0关,1开 |
ntp_server | ntp服务器地址 |
返回值code, 0:成功,非0:失败
{
"code": 0
}
例:
/webapi/system/time/get
获取设备时间
返回参数
字段 | 描述 |
---|---|
time | 设备当前的utc时间,单位:秒。 |
time_zone | 设备当前时区,单位:秒,时区3600。如北京时区:83600=28800。 |
ntp_enable | ntp校时开关 |
ntp_server | ntp服务器地址 |
code | 错误码 |
返回值code, 0:成功,非0:失败
{
"code": 0,
"ntp_enable": 1,
"ntp_server": "ntp2.netwrx1.com",
"time": 1574737650,
"time_zone": 28800
}
例:
http://192.168.102.77/webapi/system/time/get?user=admin&passwd=admin
/webapi/net/eth/set
设置有线网络参数
参数
字段 | 描述 |
---|---|
dhcp | 动态获取IP,1:DHCP, 0:静态IP。 |
ip | 有线网卡IP |
netmask | 有线网卡子网掩码 |
gateway | 有线网卡网关 |
mtu | 有线网卡MTU |
返回值code, 0:成功,非0:失败
{
"code": 0
}
例:
/webapi/net/eth/get
获取有线网络参数
返回参数
字段 | 描述 |
---|---|
dhcp | 动态获取IP,1:DHCP, 0:静态IP。 |
ip | 有线网卡IP |
netmask | 有线网卡子网掩码 |
gateway | 有线网卡网关 |
mtu | 有线网卡MTU |
state | 网卡状态 |
mac | mac地址 |
例:
http://192.168.102.77/webapi/net/eth/get?user=admin&passwd=admin
返回json示例(getNetcfg)
{
"code": 0,
"dhcp": 0,
"gateway": "192.168.100.3",
"ip": "192.168.102.58",
"mac": "00:01:02:03:04:00",
"mtu": 1400,
"netmask": "255.255.0.0",
"state": 1
}
/webapi/net/wifi/set
设置wifi参数
参数
字段 | 描述 |
---|---|
dhcp | 动态获取IP,1:DHCP, 0:静态IP。 |
ip | 无线网卡IP |
netmask | 无线网卡子网掩码 |
gateway | 无线网卡网关 |
mtu | 无线网卡MTU |
ssid | wifi名字 |
psk | wifi密码 |
ap_mode | 是否启用ap模式 |
ap_ssid | ap模式下接入点热点名字 |
ap_psk | ap模式下接入点热点密码 |
返回值code, 0:成功,非0:失败
{
"code": 0
}
例:
/webapi/net/wifi/get
获取无线网络参数
返回参数
字段 | 描述 |
---|---|
dhcp | 动态获取IP,1:DHCP, 0:静态IP。 |
ip | 无线网卡IP |
netmask | 无线网卡子网掩码 |
gateway | 无线网卡网关 |
mtu | 无线网卡MTU |
ssid | wifi名字 |
psk | wifi密码 |
ap_mode | 是否启用ap模式 |
ap_ssid | ap模式下接入点热点名字 |
ap_psk | ap模式下接入点热点密码 |
例:
http://192.168.102.77/webapi/net/wifi/get?user=admin&passwd=admin
返回json示例
{
"ap_mode": 0,
"ap_ssid": "DOG-27W",
"ap_psk": "admin78",
"code": 0,
"dhcp": 0,
"gateway": "192.168.100.3",
"ip": "192.168.102.58",
"mac": "",
"mtu": 1400,
"netmask": "255.255.0.0",
"psk": "88888888",
"ssid": "Xiaomi_ACF2",
"state": 1
}
/webapi/net/dns/set
设置DNS
参数
字段 | 描述 |
---|---|
dns | DNS服务器。 |
dns_bak | 备用DNS服务器 |
例:
返回json示例
{
"code": 0
}
/webapi/net/dns/get
获取DNS
返回参数
字段 | 描述 |
---|---|
dns | DNS服务器。 |
dns_bak | 备用DNS服务器 |
例:
http://192.168.102.77/webapi/net/dns/get?user=admin&passwd=admin
返回json示例
{
"code": 0,
"dns": "192.168.100.3",
"dns_bak": "114.114.114.114"
}
/webapi/device/info
获取设备信息
返回参数
字段 | 描述 |
---|---|
code | 结果,0:成功,非0:失败 |
appVersion | 估计版本号 |
Cid | 设备ID |
rtspUrl | 设备rtsp视频流播放地址 |
LocalRecognition | 是否支持离线识别,0:不支持,1:支持 |
SupportSetVolume | 是否音量设置,0:不支持,1:支持 |
SupportVideoDirection | 是否视频反向设置,0:不支持,1:支持 |
SupportTemperature | 是否支持测温功能,0:不支持,1:支持 |
SupportThermograph | 是否支持热力图功能,0:不支持,1:支持 |
SupportVideoLive | 是否支持视频直播, 0:不支持,1:支持 |
SupportUseMode | 是否支持平台模式和单机模式切换,0:不支持(默认使用单机模式),1:支持 |
SupportThirdInterface | 是否支持第三方投递接口,0:不支持,1:支持 |
SupportWIFI | 是否支持wifi,0:不支持,1:支持 |
SupportWired | 是否支持有线网络,0:不支持,1:支持 |
SupportMultipleLanguages | 是否支持多种语言切换,0:不支持,> 0(中文,英语,法语,德语,日语,韩语,意大利语 每个占1bit) |
SupportPlayTemperature | 是否支持播放温度, 0:不支持,1:支持 |
SupportMaskDetection | 是否支持口罩检测, 0: 不支持,1:支持 |
例:
http://192.168.102.77/webapi/device/info?user=admin&passwd=admin
返回json示例
{
"code": 0,
"appVersion": "3.5.1.1174",
"Cid": "290200001002",
"rtspUrl": "rtsp://192.168.104.131:8554/live",
"LocalRecognition": 1,
"SupportVideoDirection":1,
"SupportTemperature":1,
"SupportThermograph":1
}
/webapi/record/query/tem
获取测温结果列表
请求参数
字段 | 描述 |
---|---|
Registered | 0:未注册,1:已注册,2:全部 |
Normal | 0:查询高温的测温记录,1:查询体温正常的测温记录,2:查询所有记录 |
Offset | 偏移量,从第几个开始获取 |
Number | 请求测温记录数量,最大100个. |
TimeFrom | 开始时间 |
TimeTo | 结束时间 |
返回参数 字段|描述|必要性|长度限制 ----|----|----|---- ret|结果,0:成功,非0:失败| 必填 |uint_32类型 RecordNumber| 测温结果个数,每次最多获取100个| 必填 |uint_32类型 TotalNumber| 测温记录总数| 必填 |uint_32类型 UnnormalNumber| 异常测温记录总数| 必填 |uint_32类型 TemMode| 当前温度模式 0:摄氏度,1:华氏度| 必填 | uint_32类型 ConditionTotalNumber| 符合本次查询条件的测温记录总数| 必填 |uint_32类型 TemRecordList| 正常体温结果列表数组| 必填 |object array类型 Tem | 体温(32-43摄氏度)| 必填 |float 类型 Time| 抓拍时间点,utc时间戳,单位秒| 必填 |最大长度32字节 ImagePath| 该次识别图片的存储路径| 必填 |最大长度20字节 ID|该次记录的主键,唯一标识 Tid|脸图唯一标识| 必填 pname|识别人脸姓名 | 非必填 pid |识别人脸唯一标识 | 非必填
例:
{ "ret": 0,
"TemRecordList": [
{ "Time": 1591005009, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591005009_2350_620.jpg", "ID": 5185, "Tid": 620, "pname": "", "pid": "" },
{ "Time": 1591005002, "Tem": 35.900002, "ImagePath": "http://192.168.0.102:80/file//faces/1591005002_2349_615.jpg", "ID": 5184, "Tid": 615 },
{ "Time": 1591004960, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004960_2348_600.jpg", "ID": 5183, "Tid": 600 },
{ "Time": 1591004956, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004956_2347_598.jpg", "ID": 5182, "Tid": 598 },
{ "Time": 1591004953, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004953_2346_596.jpg", "ID": 5181, "Tid": 596 },
{ "Time": 1591004951, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004951_2345_596.jpg", "ID": 5180, "Tid": 596 },
{ "Time": 1591004949, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004949_2344_596.jpg", "ID": 5179, "Tid": 596 },
{ "Time": 1591004947, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004947_2343_596.jpg", "ID": 5178, "Tid": 596 },
{ "Time": 1591004945, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004945_2342_596.jpg", "ID": 5177, "Tid": 596 },
{ "Time": 1591004944, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004944_2341_596.jpg", "ID": 5176, "Tid": 596 },
{ "Time": 1591004943, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004943_2340_596.jpg", "ID": 5175, "Tid": 596 },
{ "Time": 1591004942, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004942_2339_596.jpg", "ID": 5174, "Tid": 596 },
{ "Time": 1591004940, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004940_2338_596.jpg", "ID": 5173, "Tid": 596 },
{ "Time": 1591004940, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004940_2337_596.jpg", "ID": 5172, "Tid": 596 },
{ "Time": 1591004939, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004939_2336_596.jpg", "ID": 5171, "Tid": 596 },
{ "Time": 1591004938, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004938_2335_596.jpg", "ID": 5170, "Tid": 596 },
{ "Time": 1591004937, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004937_2334_596.jpg", "ID": 5169, "Tid": 596 },
{ "Time": 1591004937, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004937_2333_596.jpg", "ID": 5168, "Tid": 596 },
{ "Time": 1591004936, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004936_2332_596.jpg", "ID": 5167, "Tid": 596 },
{ "Time": 1591004935, "Tem": 36.599998, "ImagePath": "http://192.168.0.102:80/file//faces/1591004935_2331_596.jpg", "ID": 5166, "Tid": 596 }],
"RecordNumber": 20, "TotalNumber": 2350, "UnnormalNumber": 537, "TemMode" 1}
/webapi/tem/threshold/set
设置温度阈值参数
请求参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 当前密码 |
temMin | 最低温度, 范围0-37 |
temMax | 报警温度, 范围30-43 |
temMode | 0:摄氏度,1:华氏度 |
例:
返回json示例
{
"code": 0,
}
/webapi/tem/threshold/get
获取温度阈值参数
返回参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 当前密码 |
temMin | 最低温度, 范围0-37 |
temMax | 报警温度, 范围30-43 |
temMode | 0:摄氏度,1:华氏度 |
例:
http://192.168.102.77/webapi/tem/threshold/get?user=admin&passwd=admin
返回json示例
{
"code": 0,
"temMin": 33.0,
"temMax": 37.6,
"temMode":0
}
/webapi/tem/calibration/set
设置温度校对参数
请求参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 当前密码 |
temstandard | 额温枪温度, 范围35.3-43 |
temdevice | 测温仪温度, 范围30-43 |
temcheckstate | 1启动校对,2:完成校对 |
temMode | 0:摄氏度,1:华氏度 |
例:
返回json示例
{
"code": 0
/webapi/tem/calibration/get
获取温度校对参数
返回参数
字段 | 描述 |
---|---|
code | 0 |
temstandard | 额温枪温度, 范围35.3-43 |
temdevice | 测温仪温度, 范围30-43 |
temcheckstate | 1启动校对,2:完成校对 |
temMode | 0:摄氏度,1:华氏度 |
例:
http://192.168.102.77/webapi/tem/calibration/get?user=admin&passwd=admin
返回json示例
{
"code": 0,
"temstandard": 33.0,
"temdevice": 37.6,
"temcheckstate": 1,
"temMode":0
}
/webapi/tem/mode/set
设置温度模式
请求参数
字段 | 描述 |
---|---|
temMode | 0:摄氏度,1:华氏度 |
例:
http://192.168.102.77/webapi/tem/mode/set?user=admin&passwd=admin
返回json示例
{
"code": 0,
}
/webapi/webhook/get
获取第三方投递地址
返回参数
字段 | 描述 |
---|---|
httpUrl | 投递地址 |
例:
http://192.168.102.77/webapi/webhook/get?user=admin&passwd=admin
返回json示例
{
"code": 0,
"httpUrl":"http://192.168.103.55:8000"
}
/webapi/webhook/set
设置第三方投递地址
请求参数
字段 | 描述 |
---|---|
httpUrl | 投递地址 |
例:
http://192.168.102.77/webapi/webhook/set?user=admin&passwd=admin&httpUrl=http://192.168.103.55:8000
返回json示例
{
"code": 0
}
/webapi/webhook/test
测试第三方投递地址
返回参数
字段 | 描述 |
---|---|
httpUrl | 第三方投递地址 |
res_code | 第三方投递地址响应码 |
例:
http://192.168.102.77/webapi/webhook/test?user=admin&passwd=admin&httpUrl=http://192.168.103.55:8000
返回json示例
{
"code": 0,
"httpUrl":"http://192.168.103.55:8000",
"time":131,
"res_code":0
}
/webapi/system/reset
恢复出厂设置
例:
http://192.168.102.77/webapi/system/reset?user=admin&passwd=admin
返回json示例
{
"code": 0
}
/webapi/tem/record/clear/get
获取是否清空记录状态
返回参数
字段 | 描述 |
---|---|
state | 是否清空,0:不清空,1:清空 |
例:
http://192.168.102.77/webapi/gpio/set?user=admin&passwd=admin
返回json示例
{
"code": 0,
"state": 1
}
/webapi/tem/record/clear/set
设置是否清空记录状态
请求参数
字段 | 描述 |
---|---|
state | 是否清空,0:不清空,1:清空 |
例:
http://192.168.102.77/webapi/tem/record/clear/set?user=admin&passwd=admin&state=1
返回json示例
{
"code": 0
}
/webapi/gpio/set
设置GPIO参数
请求参数
字段 | 描述 |
---|---|
enable | 是否启用gpio,0:不启用,1:启用 |
timeout | 触发时长,单位毫秒 |
triggle_type | 关联类型,0:正常温度触发,1:温度异常触发,2:识别成功开门 |
例:
http://192.168.102.77/webapi/gpio/set?user=admin&passwd=admin&enable=1&timeout=1&triggle_type=1
返回json示例
{
"code": 0
}
/webapi/gpio/get
获取GPIO参数
例:
http://192.168.102.77:80/webapi/gpio/get?user=admin&passwd=admin
返回json示例
{
"enable": 1,
"timeout": 1000,
"triggle_type": 1,
}
/webapi/gpio/test
测试GPIO参数
请求参数
字段 | 描述 |
---|---|
enable | 是否启用gpio,0:不启用,1:启用 |
timeout | 触发时长,单位毫秒 |
triggle_type | 关联类型,0:正常温度触发,1:温度异常触发 |
例:
http://192.168.102.77/webapi/gpio/test?user=admin&passwd=admin&enable=1&timeout=1000&triggle_type=0
返回json示例
{
"code": 0
}
/webapi/rtmplive/set
设置视频推流参数
请求参数
字段 | 描述 |
---|---|
enable | 开启视频推流,0:不启用,1:启用 |
live_url | 视频推流地址 |
push_times | 推流时长,单位s, 0:一直推流 |
例:
返回json
{
"code": 0,
}
/webapi/rtmplive/get
获取视频推流参数
返回参数
字段 | 描述 |
---|---|
code | 返回码 |
enable | 开启视频推流,0:不启用,1:启用 |
live_url | 视频推流地址 |
push_times | 推流时长,单位s, 0:一直推流 |
例:
http://192.168.102.77:80/webapi/rtmplive/get?user=admin&passwd=admin
返回json
{
"code": 0,
"enable": 0,
"live_url":"",
"push_times":0
}
/webapi/rtmplive/test
测试视频推流参数
请求参数
字段 | 描述 |
---|---|
enable | 开启视频推流,0:不启用,1:启用 |
live_url | 视频推流地址 |
push_times | 推流时长,单位s, 0:一直推流 |
例:
返回json
{
"code": 0,
"server_code": 0,
"time":131
}
/webapi/log/system
日志接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.102.77/webapi/log/system?user=admin&passwd=admin
返回值code, 0:成功,负数:失败
{
"code": 0,
"url": "http://192.168.102.77/webapi/file/download?file=tmp/ws_295600000006.zip"
}
/webapi/sound/status/set
音量设置接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
volume | 音量 |
normal_switch | 正常提示音开关 |
unnormal_switch | 异常提示音开关 |
temperature_switch | 温度语音开关 |
mask_switch | 口罩语音开关 |
audio_Languages | 音频语言 (中文,英语,法语,德语,日语,韩语,意大利语 每个占1bit) |
例:
返回值code, 0:成功,负数:失败
{
"code": 0,
}
/webapi/sound/status/get
音量获取接口
返回参数
字段 | 描述 |
---|---|
volume | 音量 |
normal_switch | 正常提示音开关 |
unnormal_switch | 异常提示音开关 |
temperature_switch | 温度语音开关 |
mask_switch | 口罩语音开关 |
audio_languages | 音频语言 (中文,英语,法语,德语,日语,韩语,意大利语 每个占1bit) |
例:
http://192.168.104.125/webapi/sound/status/get?user=admin&passwd=admin
返回值code, 0:成功,负数:失败
{
"code": 0,
"volume": 60,
"normal_switch": 1,
"unnormal_switch":1,
"temperature_switch":0,
"mask_switch":0,
"audio_Languages":1
}
/webapi/screen_savers/status/set
设置屏幕显示控制接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
tem_show | 是否显示温度,1:显示,0:不显示 |
time_min | 时间,0:不进入屏保,非0是无人times后进入屏保 (单位分钟) |
例:
http://192.168.104.125/webapi/screen_savers/status/set?user=admin&passwd=admin&tem_show=1&time_min=1
返回值code, 0:成功,负数:失败
{
"code": 0,
}
/webapi/screen_savers/status/get
获取屏幕接口
返回参数
字段 | 描述 |
---|---|
tem_show | 是否显示温度,1:显示,0:不显示 |
time_min | 时间,0:不进入屏保,非0是无人times后进入屏保 (单位分钟) |
例:
http://192.168.104.125/webapi/screen_savers/status/get?user=admin&passwd=admin
返回值code, 0:成功,负数:失败
{
"code": 0,
"tem_show": 1,
"time_min": 1,
}
/webapi/screen_savers/upload
上传屏保图片接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
image | 图片文件,格式base64 |
例:
http://192.168.104.125/webapi/screen_savers/upload?user=admin&passwd=admin&image=1
返回值code, 0:成功,负数:失败 -1:文件是空,-3:保存文件失败
{
"code": 0,
}
/webapi/screen_savers/delete
删除屏保图片接口
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.125/webapi/screen_savers/delete?user=admin&passwd=admin
返回值code, 0:成功,负数:失败 -2:文件已删除
{
"code": 0,
}
/webapi/record/export
记录导出
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
Registered | 0:未注册,1:已注册,2:全部 |
Normal | 0:查询高温的测温记录,1:查询体温正常的测温记录,2:查询所有记录 |
Offset | 偏移量,从第几个开始获取 |
Number | 请求测温记录数量,最大100个. |
TimeFrom | 开始时间 |
TimeTo | 结束时间 |
例:
返回值code, 0:成功,负数:失败
{
"code": 0,
"file_path": "http://192.168.104.118/webapi/file/download?file=record.zip",
}
/webapi/record/clear
清空记录
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/record/clear?user=admin&passwd=admin
返回值code, 0:成功,负数:失败
{
"code": 0,
}
/webapi/record/get/save/state
获取记录是否保存
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/record/get/save/state?user=admin&passwd=admin
返回值
字段 | 描述 |
---|---|
code | 0:成功,负数:失败 |
state | 0: 不保存,1:保存 |
{
"code": 0,
"state":1
}
/webapi/record/set/save/state
设置记录保存
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
state | 状态:0:不保存,1:保存 |
例:
http://192.168.104.118/webapi/set/save/state?user=admin&passwd=admin&state=1
返回值code, 0:成功,负数:失败
{
"code": 0,
}
/webapi/system/time/format/set
设置系统小时制
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
format | 12/24小时制 0:12小时,1:24小时 |
例:
http://192.168.104.118/webapi/system/time/format/set?user=admin&passwd=admin&format=0
返回值code, 0:成功,负数:失败
{
"code": 0,
}
/webapi/system/time/format/get
获取系统小时制
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/system/time/format/get?user=admin&passwd=admin
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
format | 12/24小时制 0:12小时,1:24小时 |
{
"code": 0,
"format": 0,
}
/webapi/member/register
注册人脸
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
pid | 用户ID |
pname | 用户名 |
face | 二进制脸图数据 |
(人脸图片格式要求: 1:不超过60k 2:yuv420的jpeg格式 3:无遮挡清晰人脸,人脸区域大于100100像素,即瞳距大于等于50像素 4:图片小于等于1280720,且边长尺寸为16的倍数,推荐800*640)
例:
方法:post
格式:form-data
user=admin&passwd=admin&pid=123&pname=lwg&face=binary_file
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/member/device/register
设备自主注册人脸
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
pid | 用户ID |
pname | 用户名 |
接口说明
- 描述:web触发后,提示人脸对着设备,设备截图注册。一分钟超时。
例:
http://192.168.104.118/webapi/member/device/register?user=admin&passwd=admin
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
"pid": "123445555",
}
/webapi/member/remove
人脸删除,支持多个删除
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
id | 人脸ID, 如果是多个使用“,” 隔开 |
例:
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/member/clear
清空脸库
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/member/clear?user=admin&passwd=admin
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/member/query
查询脸库信息
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
page | 当前页 为空返回第一页 |
limit | 人脸个数 为空返回20条 |
keyword | 查询条件,pid或者pname 为空都查询 |
例:
http://192.168.104.118/webapi/member/query?user=admin&passwd=admin&page=1&limit=20
返回参数
字段 | 描述 | |
---|---|---|
code | 返回值 0:成功,负数:失败 | |
total | 人脸总数 | |
person | 人脸信息 | |
id | 序号 | 整形 |
pid | 人脸ID | 字符串 |
pname | 姓名 | 字符串 |
access_start | 门禁有效开始时间戳 | |
access_end | 门禁有效结束时间戳 | 备注:0总有效 |
{
"code": 0,
"total":100,
"person": [
{ "id": 1, "pid": "123", "pname": "luoweigang", "access_start": 0, "access_end": 0 },
{ "id": 2, "pid": "234", "pname": "luoweigang", "access_start": 0, "access_end": 0 }]
}
/webapi/member/edit
修改人脸信息
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
pid | 人脸ID |
pname | 姓名 |
face | 二进制脸图数据 |
例:
方法:post
格式:form-data
user=admin&passwd=admin&pid=123&pname=lwg&face=binary_file
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/member/access/date
人脸门禁日期
参数
字段 | 描述 | |
---|---|---|
user | 用户名 | |
passwd | 密码 | |
pid | 人脸ID | |
start | 开始时间戳 单位s | |
end | 结束时间戳 单位s | 备注:为0时不过滤时间 |
例:
user=admin&passwd=admin&pid=123&start=0&end=0
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/use/mode/get
获取使用模式
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/use/mode/get?user=admin&passwd=admin
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
type | 模式类型,1:单机模式,0:平台模式 |
{
"code": 0,
"type": 0,
}
/webapi/use/mode/set
修改使用模式
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
type | 模式类型,1:单机模式,0:平台模式 |
例:
http://192.168.104.118/webapi/use/mode/set?user=admin&passwd=admin&type=0
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}
/webapi/white/light/get
获取白光灯状态
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
例:
http://192.168.104.118/webapi/white/light/get?user=admin&passwd=admin
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
state | 状态,0:自动,1:常开,2:常闭 |
{
"code": 0,
"state": 0,
}
/webapi/white/light/set
修改白光灯状态
参数
字段 | 描述 |
---|---|
user | 用户名 |
passwd | 密码 |
state | 状态,0:自动,1:常开,2:常闭 |
例:
http://192.168.102.183/webapi/white/light/set?user=admin&passwd=admin&state=1
返回参数
字段 | 描述 |
---|---|
code | 返回值 0:成功,负数:失败 |
{
"code": 0,
}