预计更新时间: 2021-10-28 更新日志: 修改获取设备人员信息接口
更新时间: 2021-03-10 更新日志: 增加更新闸机人脸照片接口
更新时间: 2020-10-28 更新日志: 增加人员录入设备注意事项
更新时间: 2020-04-28 更新日志: 增加人脸校验合格要求
更新时间: 2020-04-06 更新日志: 支持测温设备操作
更新时间: 2020-02-27 更新日志: 增加温度数据接口
调用中悦数据平台接口时,需使用HTTP协议、form表单数据格式、UTF8编码,访问域名为http://api.facejoy.com
请求方式:POST(HTTP)
请求地址:http://api.facejoy.com
请求包体:
...
参数说明:
...
SDK请求示例:
...
返回结果:
...
每个开发者管理员对应着一个userID,调用时需要携带此Id进行对该企业进行一系列的操作,此Id可以通过迎宾码直接获取
每次请求接口时需带上userID、timeStamp、accessToken三个参数
参数 | 类型 | 说明 |
---|---|---|
userID | int | 用户身份Id |
timeStamp | Long | 当前时间戳,格式:1563784721356 |
accessToken | String | 校验码 |
生成accessToken的Java版代码如下:
public static String genAccessToken(String password, Long timestamp) throws NoSuchAlgorithmException {
MessageDigest md5 = MessageDigest.getInstance("MD5");
char[] charArray = password.toCharArray();
byte[] byteArray = new byte[charArray.length];
for (int i = 0; i < charArray.length; i++)
byteArray[i] = (byte) charArray[i];
byte[] md5Bytes = md5.digest(byteArray);
StringBuffer hexValue = new StringBuffer();
for (int i = 0; i < md5Bytes.length; i++) {
int val = ((int) md5Bytes[i]) & 0xff;
if (val < 16)
hexValue.append("0");
hexValue.append(Integer.toHexString(val));
}
String[] array = new String[] { hexValue.toString(), timestamp.toString() };
StringBuffer sb = new StringBuffer();
for (int i = 0; i < 2; i++) {
sb.append(array[i]);
}
String str = sb.toString();
MessageDigest md = MessageDigest.getInstance("SHA-1");
md.update(str.getBytes());
byte[] digest = md.digest();
StringBuffer hexstr = new StringBuffer();
String shaHex = "";
for (int i = 0; i < digest.length; i++) {
shaHex = Integer.toHexString(digest[i] & 0xFF);
if (shaHex.length() < 2) {
hexstr.append(0);
}
hexstr.append(shaHex);
}
return hexstr.toString();
}
{
"timeStamp": "1563783958119",
"msg": "SUCCESS",
"code": 0,
"accessToken": "x",
"userID": 123
}
code=0时,msg返回SUCCESS并携带timeStamp、userID、accessToken供用户做校验
code=1时,msg返回错误信息
Path: /admin/api/sysUserMessage/getUserIDByCode
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
code | text | 是 | 迎宾码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/createFaceSet
Method: POST
接口描述:
为当前企业创建一个人脸库,不允许存在同名人脸库
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceSetName | text | 是 | 人脸库名称 | |
faceSetType | text | 是 | 人脸库所属类型0 表 Vip 1 表 白名单 2 表 黑名单 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) | ||
faceTypeId | number | 非必须 | 人脸库Id |
Path: /admin/api/faceMessage/updateFaceSetName
Method: POST
接口描述:
修改人脸库名称
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
newFaceSetName | text | 是 | 新人脸库名称 | |
faceTypeId | text | 是 | 人脸库Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/deleteFaceSetById
Method: POST
接口描述:
删除人脸库
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳 | ||
msg | string | 非必须 | 返回信息状态SUCCESS/ERROR | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/cwMessage/getFaceSetsByUserId
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"faceSets": [
{
"typeName": "访客",
"crtTime": "2018-12-17 18:30:19",
"faceTypeId": 312
},
{
"typeName": "教师",
"crtTime": "2018-12-17 18:30:41",
"faceTypeId": 314
}
],
"accessToken": "x",
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 用户ID(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
faceSets | object [] | 非必须 | 人脸库集合 | item 类型: object |
|
├─ typeName | string | 必须 | 人脸库名字 | ||
├─ crtTime | string | 必须 | 人脸库创建时间 | ||
├─ faceTypeId | number | 必须 | 人脸库Id | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/addFaceToFaceSet
Method: POST
接口描述:
将一个人脸添加到人脸库中,一个人脸可以对应多个人脸库
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id | |
faceId | text | 是 | 人脸Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/removeFaceToFaceSet
Method: POST
接口描述:
将人脸从人脸库中移除
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id | |
faceId | text | 是 | 人脸Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/getFaceByFaceTypeId
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"accessToken": "X",
"faceList": [
{
"imageUrl": "https://X.jpg",
"name": "李四",
"faceId": 108035
}
],
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
faceList | object [] | 非必须 | item 类型: object |
||
├─ imageUrl | string | 非必须 | 人脸图片地址 | ||
├─ name | string | 非必须 | 人脸名称 | ||
├─ faceId | number | 非必须 | 人脸id | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/checkFaceImg
Method: POST
接口描述:
检测人脸照片是否符合规范。
1.人脸图片转base64后大小小于500KB;
2.具备人脸基本特征
3.图片尺寸最大支持1920*1080
4.图片现只支持jpg格式
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
picture | text | 是 | 人脸图片base64格式;数据格式:Data:image/png;base64,iVBO...;小大:30KB~500KB |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | string | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/addFaceMessage
Method: POST
接口描述:
添加人脸信息,添加时需指定一个人脸库
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id | |
name | text | 是 | 人脸名称(人脸名称长度不超过5个中文) | |
picture | text | 是 | Data:image/png;base64,iVBO... | 人脸图片base64Data |
faceNumber | text | 否 | 人脸编号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
faceId | number | 非必须 | 人脸id |
Path: /admin/api/faceMessage/updateFace
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceId | text | 是 | 人脸Id | |
newName | text | 否 | 新的人脸名称 | |
newPicture | text | 否 | Data:image/png;base64,iVBO... | 新的人脸图片 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/visitorMessage/uploadVisitorMessage
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
visitorName | text | 是 | 访客名称 | |
cardImgUrl | text | 是 | 身份证证件照 base64格式(无格式前缀) | |
visitorImgUrl | text | 是 | 访客采集照片 base64格式(无格式前缀) | |
visitorCard | text | 是 | 身份证号码 | |
visitorSex | text | 是 | 性别 男/女 | |
cardStatus | text | 是 | 身份证是否过期 0-没有过期 1-已经过期 | |
tag | text | 是 | 备注 | |
region | text | 是 | 申请区域 | |
visitorTime | text | 是 | 来访时间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
faceId | number | 非必须 | 人脸ID | ||
visitorId | number | 非必须 | 访客ID |
Path: /admin/api/deviceConfigAPI/getCameraConfigArea
Method: POST
接口描述:
请求成功后返回如下数据:
{
"msg": "SUCCESS",
"timeStamp": 1574408067081,
"code": 0,
"rules": [
{
"date": [
{
"startTime": "04:00:00",
"endTime": "06:00:00"
}
],
"areaId": 1,
"areaName": "测试按天循环",
"areaMode": 1
},
{
"date": [
[
{
"startTime": "07:00:00",
"endTime": "08:00:00"
}
],
[
{
"startTime": "01:00:00",
"endTime": "02:00:00"
}
],
[
{
"startTime": "02:00:00",
"endTime": "03:00:00"
}
],
[
{
"startTime": "03:00:00",
"endTime": "04:00:00"
}
],
[
{
"startTime": "04:00:00",
"endTime": "05:00:00"
}
],
[
{
"startTime": "05:00:00",
"endTime": "06:00:00"
}
],
[
{
"startTime": "06:00:00",
"endTime": "07:00:00"
}
]
],
"areaId": 1,
"areaName": "测试按周",
"areaMode": 2
}
],
"accessToken": "2ba3184b082c8e4b26664a254642a8d6a4b95d71",
"userID": 269086
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 非必须 | |||
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
rules | object [] | 非必须 | 规则集合 | item 类型: object |
|
├─ date | object [] | 必须 | 时间集合 | item 类型: object |
|
├─ startTime | string | 必须 | 开始时间 | ||
├─ endTime | string | 必须 | 结束时间 | ||
├─ areaId | number | 必须 | 规则ID | ||
├─ areaName | string | 必须 | 规则名字 | ||
├─ areaMode | number | 必须 | 规则模式(1或2)1:按每天循环 2:按周循环 | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/updateDeviceDirection
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
direction | text | 是 | 设备方向(0:进,1出) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/getDeviceWithState
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
deviceList | object [] | 非必须 | item 类型: object |
||
├─ ip | string | 必须 | 设备ip | ||
├─ position | string | 必须 | 设备位置 | ||
├─ deviceId | string | 必须 | 设备编号 | ||
├─ cameraType | number | 必须 | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) | ||
├─ cameraState | number | 必须 | 设备状态(0:在线;1:不在线) | ||
├─ direction | number | 必须 | 设备方向(0:进,1:出)有设置方向才有此字段 | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/addCameraConfigArea
Method: POST
接口描述:
{
"timeListJson": [{
"startTime": "01:00:00",
"endTime": "02:00:00"
},
{
"startTime": "04:00:00",
"endTime": "06:00:00"
},
{
"startTime": "07:00:00",
"endTime": "10:00:00"
},
{
"startTime": "11:00:00",
"endTime": "13:00:00"
},
{
"startTime": "18:00:00",
"endTime": "23:00:00"
}
]
}
每一对startTime跟endTime对应一个时间段,最多设置5组,至少一组
{
"timeListJson": [
[{
"startTime": "01:00:00",
"endTime": "02:00:00"
}, {
"startTime": "04:00:00",
"endTime": "06:00:00"
}, {
"startTime": "07:00:00",
"endTime": "10:00:00"
}],
[],
[],
[],
[],
[],
[{
"startTime": "01:00:00",
"endTime": "02:00:00"
}, {
"startTime": "04:00:00",
"endTime": "06:00:00"
}, {
"startTime": "07:00:00",
"endTime": "10:00:00"
}, {
"startTime": "11:00:00",
"endTime": "13:00:00"
}, {
"startTime": "18:00:00",
"endTime": "23:00:00"
}]
]
}
timeListJson必须包含7个数组。
第一个数组表示周一,里面的内容是周一的时间规则,时间规则最多包含5组。
第二个数组表示周二,里面的内容是周二的时间规则,时间规则最多包含5组。以此类推
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
mode | text | 是 | 规则模式(1或2)1:按每天循环 2:按周循环 | |
areaName | text | 是 | 规则名称 | |
timeListJson | text | 是 | 时间规则 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
areaId | number | 非必须 | 对应规则的Id | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/deleteCameraConfigArea
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
areaId | text | 是 | 对应规则的Id | |
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/updateCameraConfigArea
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
mode | text | 是 | 规则模式(1或2)1:按每天循环 2:按周循环 | |
areaName | text | 是 | 规则名称 | |
timeListJson | text | 是 | 时间规则 | |
areaId | text | 是 | 规则Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
areaId | number | 非必须 | 对应规则的Id | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/addAreaToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
areaId | text | 是 | 对应规则的Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/removeAreaToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
areaId | text | 是 | 对应规则的Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/updateAreaToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
areaId | text | 是 | 规则Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/visitorMessage/agreeVisitorMessage
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
expireDate | text | 是 | 过期时间(为空时过期时间为当天的23:59:59) | |
visitorId | text | 是 | 访客ID | |
deviceId | text | 是 | 设备编号选填 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/bindDeviceToEnterprise
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
targetUserId | text | 是 | 需要绑定设备的企业userId |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | string | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/deviceConfigAPI/logoutDevice
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/addFaceSetToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
areaId | text | 否 | 对应规则的Id | |
deviceId | text | 是 | 设备编号 | |
faceTypeId | text | 是 | 人脸库Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
2021-10-28更新日志:
1.添加isArea, isThumbImageData字段,优化查询方式
2.修改每页最大条数为200
3.thumbImageData字段在isThumbImageData=0时返回为空
Path: /admin/api/faceMessage/facesList
Method: POST
接口描述:
分页获取设备中人员的信息
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deviceId | text | 是 | 设备编号 | |
page | text | 是 | 当前页数 | |
rows | text | 是 | 每页显示条数(最大不超过200条) | |
faceName | text | 否 | 人员名称 | |
isArea | text | 否 | 通过是否有规则过滤查询信息(0-获取所有有规则的人员,1-获取所有无规则的人员,不填默认获取全部) | |
isThumbImageData | text | 否 | 是否需要base64图片(0-不需要,不填默认获取全部) | |
userID | text | 是 | 用户Id | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
resCode | string | 非必须 | |||
resMsg | string | 非必须 | |||
resData | object | 非必须 | |||
├─ total | number | 非必须 | 设备记录条数 | ||
├─ staff | object [] | 必须 | 人员信息集合 | item 类型: object |
|
├─ role | number | 必须 | 人员类型 | ||
├─ areaId | number | 必须 | 规则Id | ||
├─ thumbImageData | string [] | 非必须 | base64 | item 类型: string |
|
├─ areaName | string | 必须 | 规则名称 | ||
├─ name | string | 必须 | 人员名称 | ||
├─ id | string | 必须 | 人员ID | ||
msgId | null | 非必须 | |||
resTime | string | 非必须 |
Path: /admin/api/faceMessage/deleteFaceSetFromCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
faceTypeId | text | 是 | 人脸库Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
注意:下发人脸照片到设备请尽量不要频繁使用此接口。单张照片下发到设备,受到设备性能影响,容易出现不稳定的情况。 建议先上传到人脸库,让人脸库累积一定的人脸数量,然后定时通过人脸库下发接口有序下发到设备。人脸库下发只下发新增的人脸
例如:昨天的人脸库有100条记录,已经全部导入闸机,今天新增了10条,调用下发人脸库的操作后,只有10条记录会被下发, 故增量下发耗时仅为增量下发部分。
Path: /admin/api/faceMessage/addFaceToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceId | text | 是 | 人脸Id | |
faceTypeId | text | 是 | 人脸库Id | |
deviceId | text | 是 | 设备名称 | |
areaId | text | 否 | 对应规则的Id 只有闸机才能配置 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/removeFaceToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceId | text | 是 | 人脸Id | |
deviceId | text | 是 | 设备名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/updateFaceToCamera
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceId | text | 是 | 人脸Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/updateAreaToFace
Method: POST
接口描述:
主要是更新闸机中的人脸规则,也就是开闸规则
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
faceId | text | 是 | 人脸Id | |
areaId | text | 否 | 时间规则Id(不传默认清空规则) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/updateFaceById
Method: POST
接口描述:
主要是更新闸机中的人脸照片
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
faceId | text | 是 | 人脸Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/cwMessage/getCwDayRecordByFaceType
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"cwDayRecordList": [
{
"firstSign": null,
"lastSign": null,
"cumulativeTime": "0",
"name": "何子寒",
"status": [
"absenteeism"
]
},
{
"firstSign": null,
"lastSign": null,
"cumulativeTime": "0",
"name": "洪卓铭",
"status": [
"absenteeism"
]
}
],
"accessToken": "x",
"signDate": "2018-11-29",
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人员类型ID | |
dateTime | text | 是 | 2018-10-10 | 考勤日期 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
cwDayRecordList | object [] | 非必须 | 日考勤信息集合 | item 类型: object |
|
├─ firstSign | number | 必须 | 签到时间 | ||
├─ lastSign | number | 必须 | 签退时间 | ||
├─ cumulativeTime | string | 必须 | 累计时间 | ||
├─ name | string | 必须 | 人员名称 | ||
├─ status | string [] | 必须 | 考勤状态 (normal:正常 absenteeism:缺勤 leave:早退 late:迟到 uncheck:漏打卡) | item 类型: string |
|
├─ | 非必须 | ||||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
signDate | string | 非必须 | 考勤日期 | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/cwMessage/getCwMonthRecordByFaceType
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"cwMonthRecordList": [
{
"normalTimes": 0,
"absenteeismTimes": 21,
"uncheckTimes": 0,
"name": "何子寒",
"leaveTimes": 0,
"lateTimes": 0
},
{
"normalTimes": 0,
"absenteeismTimes": 21,
"uncheckTimes": 0,
"name": "洪卓铭",
"leaveTimes": 0,
"lateTimes": 0
}
],
"accessToken": "x",
"signDate": "2018-11",
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
faceTypeId | text | 是 | 人脸库Id | |
year | text | 是 | 2019 | 年份 |
month | text | 是 | 07 | 月份 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
cwMonthRecordList | object [] | 非必须 | 月考勤集合 | item 类型: object |
|
├─ normalTimes | number | 必须 | 正常次数 | ||
├─ absenteeismTimes | number | 必须 | 缺勤次数 | ||
├─ uncheckTimes | number | 必须 | 漏打卡次数 | ||
├─ name | string | 必须 | 人员名称 | ||
├─ leaveTimes | number | 必须 | 早退次数 | ||
├─ lateTimes | number | 必须 | 迟到次数 | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
signDate | string | 非必须 | 考勤日期 | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/clockFaceMessage/getClockFaceByTime
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"clockFaceList": [
{
"personName": "张三",
"imageDataUrl": "[https://X.jpg](https://X.jpg)",
"captureTime": "2019-05-30 22:26:42",
"personRole": 1,
"faceId": 23668,
"position": "中悦展厅闸机进方向",
"deviceId": "7432840e1d1bbcc5",
"faceNumber": null,
"cameraType": 2,
"direction": 1,
"temp": "36.5"
}
],
"code": "SUCCESS",
"accessToken": "x",
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
startTime | text | 是 | 2019-05-30 22:26:41 | 开始时间 |
endTime | text | 是 | 2019-05-30 22:26:45 | 结束时间 |
faceId | text | 是 | 人脸Id选填 | |
deviceId | text | 是 | 设备编号选填 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
clockFaceList | object [] | 非必须 | item 类型: object |
||
├─ personName | string | 必须 | 人员名称 | ||
├─ imageDataUrl | string | 必须 | 图片地址 | ||
├─ captureTime | string | 必须 | 抓拍时间 | ||
├─ personRole | number | 必须 | 人员类型 | ||
├─ faceId | number | 必须 | 人脸Id | ||
├─ position | string | 必须 | 抓拍位置 | ||
├─ deviceId | string | 必须 | 设备编号 | ||
├─ faceNumber | string | 必须 | 人员编号 | ||
├─ cameraType | number | 必须 | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) | ||
├─ direction | number | 必须 | 设备方向(0:进,1:出)有设置方向才有此字段 | ||
├─ temp | String | 必须 | 温度 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/getPicByDeviceIdDetail
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"accessToken": "X",
"faceList": [
{
"enStrangerList": [
{
"captureTime": 1559226401000,
"url": "https://X.jpg",
"cameraType": 2,
"direction": 1,
}
]
},
{
"clockFaceList": [
{
"personName": "张三",
"number": "",
"captureTime": 1559226402000,
"id": 23668,
"url": "https://X.jpg",
"cameraType": 2,
"direction": 1,
"temp": "36.5"
}
]
}
],
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
startTime | text | 是 | 2019-05-30 22:26:41 | 开始时间 |
endTime | text | 是 | 2019-05-30 22:26:41 | 结束时间 |
initial | text | 是 | 0 | 从第几条记录开始 |
page | text | 是 | 1 | 搜索记录数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
faceList | object [] | 非必须 | item 类型: object |
||
├─ enStrangerList | object [] | 非必须 | 陌生人抓拍集合 | item 类型: object |
|
├─ captureTime | number | 非必须 | 陌生人图片抓拍时间 | ||
├─ url | string | 非必须 | 陌生人抓拍图片地址 | ||
├─ cameraType | number | 非必须 | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) | ||
├─ direction | number | 非必须 | 设备方向(0:进,1:出)有设置方向才有此字段 | ||
├─ clockFaceList | object [] | 非必须 | 人员集抓拍集合 | item 类型: object |
|
├─ personName | string | 非必须 | 员工姓名 | ||
├─ number | string | 非必须 | 员工编号 | ||
├─ captureTime | number | 非必须 | 员工图片抓拍时间 | ||
├─ id | number | 非必须 | 人脸所属id(faceId) | ||
├─ url | string | 非必须 | 员工抓拍图片地址 | ||
├─ cameraType | number | 非必须 | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) | ||
├─ direction | number | 非必须 | 设备方向(0:进,1:出)有设置方向才有此字段 | ||
├─ temp | String | 必须 | 温度 | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/faceMessage/getPicByDeviceId
Method: POST
接口描述:
请求成功后返回如下数据:
{
"timeStamp": 1563515395833,
"msg": 0,
"code": "SUCCESS",
"accessToken": "X",
"faceList": [
{
"captureTime": 1559226402000,
"id": 23668,
"url": "https://X.jpg",
"cameraType": 2,
"direction": 1,
"temp": "36.5"
}
],
"userID": 123
}
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
deviceId | text | 是 | 设备编号 | |
startTime | text | 是 | 2018-10-24 | 开始时间 |
endTime | text | 是 | 2018-10-26 | 结束时间 |
initial | text | 是 | 0 | 从第几条记录开始 |
page | text | 是 | 1 | 搜索记录数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
faceList | object [] | 非必须 | item 类型: object |
||
├─ captureTime | number | 非必须 | 陌生人图片抓拍时间 | ||
├─ id | number | 非必须 | 人脸所属id(faceId) | ||
├─ url | string | 非必须 | 员工抓拍图片地址 | ||
├─ cameraType | number | 非必须 | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) | ||
├─ direction | number | 非必须 | 设备方向(0:进,1:出)有设置方向才有此字段 | ||
├─ temp | String | 非必须 | 温度 | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |
Path: /admin/api/enterpriseMessageAPI/addEnterprise
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
loginName | text | 是 | zhangsan | 登录账号(账号由至少6位数字或英文自由组成) |
userName | text | 是 | 张三 | 用户名 |
password | text | 是 | zhangsan123 | 密码 |
enterpriseName | text | 是 | 深圳市中悦科技有限公司 | 企业名称 |
shortName | text | 是 | 中悦科技 | 企业简称 |
text | 是 | xxx@163.com | 邮箱地址 | |
telphone | text | 是 | 188xxx | 联系号码 |
sysVersion | text | 是 | 46751a59d2d24ccbbf9f21453d747ea5 | 版本号。企业版:[46751a59d2d24ccbbf9f21453d747ea5],教师版:[8056294339814ed0be792d2f4cd35c41] |
province | text | 是 | 广东省 | 所在省 |
city | text | 是 | 深圳市 | 所在市 |
district | text | 是 | 龙岗区 | 所在区 |
address | text | 是 | 广东省深圳市龙岗区XXX写字楼 | 地址 |
remark | text | 是 | 备注 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | string | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) | ||
newUserID | number | 非必须 | 新企业的管理员userID |
Path: /admin/api/enterpriseMessageAPI/getEnterpriseByUserId
Method: POST
接口描述:
通过userID获取迎宾码
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | string | 非必须 | 迎宾码 | ||
userID | number | 非必须 | 用户ID(请求成功时返回) | ||
accessToken | string | 非必须 | 校验码 | ||
timeStamp | number | 非必须 | 时间戳 |
Path: /admin/api/enterpriseMessageAPI/updatePushUrl
Method: POST
接口描述:
该接口会更新该企业包括该企业创建的子企业的抓拍图片推送地址
设置推送地址后,会向设置的接口推送如下数据:
{
"deviceId": "xx",
"role": 0,
"captureTime": 1563527379723,
"captureImageUrl": "http://1.jpg",
"cameraType": 1,
"direction": 0,
"faceId": 123,
"timeStamp": 1563527379723,
"checkCode": 1231231,
"temp": "36.5"
}
参数 | 类型 | 说明 |
---|---|---|
deviceId | string | 设备编号 |
role | number | 人脸类型 -1:陌生人;0:VIP;1:白名单;2:黑名单; |
captureTime | number | 抓拍时间 |
captureImageUrl | string | 抓拍图片 |
cameraType | number | 设备类型(1-摄像头2-闸机通道设备 3-教室签到设备) |
direction | number | 设备方向(0:进,1:出)有设置方向才有此字段 |
faceId | number | 人脸Id |
timeStamp | number | 时间戳 |
checkCode | string | 校验码生成方式:userID拼接timeStamp使用md5加密用户可以通过自己生成对比checkCode验证消息是否安全 |
temp | String | 温度 |
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
userID | text | 是 | 用户ID | |
timeStamp | text | 是 | 时间戳 | |
accessToken | text | 是 | 校验码 | |
pushUrl | text | 是 | 图片回调地址支持http/https格式http |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
timeStamp | number | 非必须 | 时间戳(请求成功时返回) | ||
msg | string | 非必须 | 返回信息状态SUCCESS/错误信息 | ||
code | number | 非必须 | 状态码(0表成功,1表异常) | ||
accessToken | string | 非必须 | 校验码(请求成功时返回) | ||
userID | number | 非必须 | 用户ID(请求成功时返回) |