1.激活设备
- 描述
使用设备前调用此接口激活设备，使用前确保设备是联网的。
激活设备后会在SD卡中新建两个默认的人脸分组，名称分别为stranger和regular，如果在SD卡中有人脸分组的条件下激活，则会先删除所有的人脸分组，然后再新建默认库。
- 请求地址
https://192.168.0.1/openapi/device/activate，192.168.0.1需要替换成实际的IPC地址
- 请求参数
| 参数名称 | 类型 | 描述 | 是否必须 |
| app_id | string | 用户应用ID，公共参数 | Y |
| timestamp | long | unix格式时间戳，秒级 | Y |
| random | long | 随机数，6-10位 | Y |
| sn | string | 设备sn | Y |
| sign | string | 整个请求参数的签名 | Y |
sign的生成参照1.5.4节签名规则，参与签名计算的签名秘钥使用激活码代替secret key进行计算。
假如需要传入的参数如下：
|
app_id:
JO83UNV983U9OR random: 289192 sn: FS101D8BS00106 timestamp: 1593029283 |
openapi激活码为12345678
则按照规则生成签名为
|
str1=”app_id=JO83UNV983U9OR&random=289192&sn=FS101D8BS00106×tamp=1593029283″ str2 = str1 + “&key=12345678” sign = MD5(str2).upper() |
最终HTTP报文请求中所带参数为
| app_id:JO83UNV983U9OR random:289192 sn:FS101D8BS00106 timestamp:1593029283 sign:72CB1C1031D3BA103D2FA1A57E171C2D |
- 响应参数
| 字段名称 | 类型 | 描述 |
| code | int | 返回码，表示操作的结果； 本接口返回码有 0、1、2、3、4、8、9、10、11，见错误码章节的描述 |
- 请求示例
POST /openapi/device/activate HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded
app_id=JO83UNV983U9OR&random=289192&sn=FS101D8BS00106×tamp=1593029283&sign=72CB1C1031D3BA103D2FA1A57E171C2D
- 返回示例
{
‘code’: 0,
}
2.获取设备基本信息
- 描述
使用此接口可以获取设备的基本信息。
- 请求地址
https://192.168.0.1/openapi/device/getInfo，192.168.0.1需要替换成实际的IPC地址
- 请求参数
此接口没有私有参数，公共参数见HTTP接口调用一章的公共参数一节描述
- 响应参数
| 字段名称 | 类型 | 描述 |
| code | int | 返回码，表示操作的结果； 本接口返回码有 0、1、2、3、5、7，见错误码章节的描述 |
| sn | string | 设备序列号 |
| model_name | string | 设备型号 |
| name | string | 设备名字 |
| software_version | string | 固件版本 |
| hardware_version | string | 硬件版本 |
| ip | string | IP地址 |
| mac | string | MAC地址 |
- 请求示例
POST /openapi/device/getInfo HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded
app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K&
- 返回示例
{
‘code’: 0,
‘data’: {
‘sn’: ‘SS101D8BS00083’,
‘model_name’: ‘FS’,
‘name’: ‘My FS’,
‘software_version’: ‘1.1.0’,
‘hardware_version’: ‘1.0.0’,
‘ip’: ‘192.168.0.1’,
‘mac’: ’04:12:24:E3:45:12 ‘,
}
}
3.恢复出厂设置
- 描述
使用此接口可以使得设备恢复出厂设置。
- 请求地址
https://192.168.0.1/openapi/device/reset，192.168.0.1需要替换成实际的IPC地址
- 请求参数
此接口没有私有参数， 公共参数见HTTP接口调用一章的公共参数一节描述
- 响应参数
| 字段名称 | 类型 | 描述 |
| code | int | 返回码，表示操作的结果； 本接口返回码有 0、1、2、3、5、7，见错误码章节的描述 |
- 请求示例
POST /openapi/device/reset HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded
app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K
- 返回示例
{
‘code’: 0,
}
4.重启设备
- 描述
使用此接口可以重启设备。
- 请求地址
https://192.168.0.1/openapi/device/reboot，192.168.0.1需要替换成实际的IPC地址
- 请求参数
此接口没有私有参数， 公共参数见HTTP接口调用一章的公共参数一节描述
- 响应参数
| 字段名称 | 类型 | 描述 |
| code | int | 返回码，表示操作的结果； 本接口返回码有 0、1、2、3、5、7，见错误码章节的描述 |
- 请求示例
POST /openapi/device/reset HTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded
app_id=mdk923idkf&random=289192×tamp=15930292837&sign=IDKNFLK392038KDS932K
POST /openapi/device/rebootHTTP/1.1
Host: 192.168.0.1
Content-Type: application/x-www-form-urlencoded
- 返回示例
{
‘code’: 0,
}
