一、重要说明

✦ 返回数据
所有接口返回均为标准 JSON,字段说明如下:
code:0-正常,否则存在错误。
msg:说明信息,一般提示错误信息
data:数据部分

✦ Token
① 开发者以供应商提供的 AppKeyAppSecret 为依据,通过获取 Token 接口获得 Token。
② 除获取 Token 接口外,所有开放接口调用都需要在 Headers 中加入上一步获取到的 Token 值,Key 为 Token。
③ 请开发者妥善管理 Token,有效期为 2 小时,请勿频繁获取,同时存在的 Token 有数量上限。

✦ 频率限制
出于服务安全性和稳定性考虑,同一个 AppKey,30 秒内调用次数超过 60 次后会被短暂限流,请注意调用频率。

二、接口列表

获取 Token
✦ Method & Uri
POST /hwcloud/rest/opening/br1/token

✦ Headers
Content-Type application/json

✦ Body
{
    "appKey": "***",
    "appSecret":"***" 
}

✦ 返回 data 说明
appId:开放应用 ID
accessToken:其他接口调用凭据
expireMs:过期时间,单位毫秒
获取设备集合
✦ Method & Uri
POST /hwcloud/rest/ipark/br2/getDeviceList

✦ 返回 data 说明
id:设备 ID
sn:设备 SN
name:设备名称
ip:设备 IP
port:设备端口
entryProperty:设备进出属性,1-进,2-出,否则-无
remark:设备备注
获取考勤打卡记录集合
✦ Method & Uri
POST /hwcloud/rest/ipark/br2/getAttRecordList

✦ Headers
Content-Type application/json

✦ Body
# startTime 不可大于 endTime
# 时间跨度不可大于 7 天
# 记录区间为 [startTime, endTime]
{
    "startTime": "2024-10-24 00:00:00",
    "endTime": "2024-10-30 23:59:59"
}

✦ 返回 data 说明
deviceId:设备 ID,具体设备信息可从“获取设备集合”接口获取
name:人员姓名
officeName:部门名称
recordTime:打卡时间,毫秒级时间戳