1. 获取考勤设备配置信息(心跳接口)
开放平台2.0-设备-获取考勤设备配置
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。 - 每次请求该接口,服务器会记录本次请求时间,该请求时间往后120秒内视为设备在线
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/open/v2/labor/device/deviceConfig |
请求方法 | POST |
请求数据类型 | JSON |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
Content-Type | application/json;charset=UTF-8 |
1.2.2. 请求体(request-body)
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
sn | string | 是 | 设备序列号(示例:84E0F423870A607A,轻筑后台配置的设备信息) |
appVersion | string | 否 | 应用版本(此字段只是做记录) |
localRecordCount | number | 否 | 本地未同步的考勤数量(此字段只是做记录) |
1.3. 响应数据
响应数据中 code, msg, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 返回码 |
msg | string | 是 | 返回消息 |
data | object | 是 | 返回数据 |
identifyScores | number | 是 | 识别阈值:0-100 |
livingDetect | number | 是 | 是否活体识别:0-不识别 1-识别 |
inOrOut | number | 是 | 进出方向:0-出,1-进,2-设备自行控制 |
recStrangerType | number | 是 | 陌生人识别:0-不识别陌生人,1-识别陌生人 |
multiplayerDetection | number | 是 | 人脸检测设置:0-检测最大人脸,并进行识别,1-检测多个人脸并进行识别 |
identifyDistance | number | 是 | 识别距离, 0-无限制,1-0.5 米以内,2-1 米以内,3-1.5 米以内,4-2 米以内,5-3 米以内,6-4 米以内 |
identifyHelmet | number | 是 | 安全帽识别:0-表示不识别安全帽输出,1-表示识别安全帽 |
name | string | 是 | 设备名称 |
projectUuid | string | 是 | 项目 UUID |
sn | string | 是 | 设备序列号 |
响应数据结构如下所示:
{
"code": 0,
"msg": "成功",
"data": {
"identifyScores": 70,
"livingDetect": 1,
"inOrOut": 1,
"recStrangerType": 1,
"multiplayerDetection": 0,
"identifyDistance": 0,
"identifyHelmet": 0,
"name": "1号门禁",
"projectUuid": "50616f42e05611eb88ecfa163e8f29b8",
"sn": "84E0F423870A607A"
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。