1.8.1. 添加设备

支持的版本：v1.2.3 +

Request:

POST /v1.0/device/add
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "timeZone": "+08:00",
            "alais": "一楼打卡机",
            "fpFunOn": "1",
            "faceFunOn": "1",
            "punchPhotoFunOn": "1",
            "punchRecordFunOn": "1"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号
timeZone N 设备时区，为空时默认东八区，即+08:00
alais N 设备别名
fpFunOn N 登记指纹功能开关，表示在此设备登记的指纹是否有效，即会不会上传到服务端。1：开（默认），0：关，当等于0时，表示设备不会上传登记的指纹信息，但是设备本地还有这些入口；若在关闭期间有登记指纹，则数据仅存在设备端，当被重新开启时，这些数据也不会重新上传，除非人为操作重新上传数据。
faceFunOn N 登记人脸功能开关，1：开（默认），0：关，处理与fpFunOn一致。
punchPhotoFunOn N 打卡照片功能开关，1：开（默认），0：关，处理与fpFunOn一致。
punchRecordFunOn N 打卡记录功能开关，1：开（默认），0：关，处理与fpFunOn一致。

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.2. 修改设备

支持的版本：v1.2.3 +

Request:

POST /v1.0/device/modify
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "timeZone": "+08:00",
            "alais": "一楼打卡机",
            "fpFunOn": "1",
            "faceFunOn": "1",
            "punchPhotoFunOn": "1",
            "punchRecordFunOn": "1"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号
timeZone N 设备时区
alais N 设备别名
fpFunOn N 登记指纹功能开关，表示在此设备登记的指纹是否有效，即会不会上传到服务端。1：开，0：关，当等于0时，表示设备不会上传登记的指纹信息，但是设备本地还有这些入口；若在关闭期间有登记指纹，则数据仅存在设备端，当被重新开启时，这些数据也不会重新上传，除非人为操作重新上传数据。
faceFunOn N 登记人脸功能开关，1：开，0：关，处理与fpFunOn一致。
punchPhotoFunOn N 打卡照片功能开关，1：开，0：关，处理与fpFunOn一致。
punchRecordFunOn N 打卡记录功能开关，1：开，0：关，处理与fpFunOn一致。

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

注意事项：

本接口对非必填的属性，仅需要传入需要改动的属性，当不包含某个属性key值时，表示此属性不变动。

1.8.3. 删除设备

支持的版本：v1.1.0 +

第三方调用接口删除设备，系统会自动删除设备信息并解绑所有与设备的绑定关系。

Request:

POST /v1.0/device/delete
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.4. 查询设备信息

支持的版本：v1.2.1 +

查询该企业下符合条件的设备列表，若没有指定查询条件，则默认返回该企业下所有设备列表。

Request:

POST /v1.0/device/query
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "needDetails": 1
        }
    }
}
参数名 必填 描述
sn N 设备序列号，精确查询
needDetails N 是否需要详细信息，当该参数为1，返回基本信息和详细信息；当该参数为空或不为1，则只返回基本信息

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
        "results": [{
            "sn": "33998400021314",
            "timezone": "+08:00",
            "alais": "一楼打卡机",
            "status": 1,
            "enable": 1,
            "localIp": "192.168.213.18",
            "remoteIp": "110.80.38.76",
            "fwVersion": "Ver 9.0.0.0-20190613",
            "details": {
                "protocol": "1",
                "protocolVer": "2.2.14",
                "model": "iFace702",
                "macAddress": "00:17:61:11:88:0f",
                "verifyRecords": 1,
                "userCount": 1,
                "faceCount": 1,
                "fingerCount": 1,
                "lastRequestTimeStamp": 1571990712,
                "supportAcc": "1"
            }
        }]
    }
}
参数名 描述
sn 设备序列号
timezone 设备时区
alais 设备别名
status 设备在线状态，1代表在线，0代表离线
enable 设备启用状态，1代表启用，0代表禁用
localIp 设备内网Ip地址
remoteIp 设备公网Ip地址
fwVersion 设备固件版本号
details 设备详细信息，其他为设备基本信息
protocol 设备通讯协议，0 pull，1 push，2 best，3 ufo，4 best-w，5 best-t
protocolVer 协议版本
model 设备型号
macAddress 设备MAC地址
verifyRecords 核验记录数
userCount 人员数
faceCount 人脸数
fingerCount 指纹数
lastRequestTimeStamp 设备最新请求时间戳
supportAcc 是否支持门禁功能，0 不支持，1支持，2未知

1.8.5. 禁用设备

支持的版本：v1.1.0 +

禁用设备，不允许设备通讯。

Request:

POST /v1.0/device/disable
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.6. 启用设备

支持的版本：v1.1.0 +

启用设备，允许设备通讯。

Request:

POST /v1.0/device/enable
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.7. 重启设备

支持的版本：v1.1.0 +

重启设备，只有启用并且在线的设备才能重启。

Request:

POST /v1.0/device/reboot
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.8. 重新上传人员信息

支持的版本：v1.1.0 +

上传设备的人员信息到系统，设备启用状态才允许操作。

Request:

POST /v1.0/device/reloadEmployeeInfo
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "onlineCheck": "1"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号
onlineCheck N 设备在线状态校验。0代表不校验设备状态，执行该操作，1代表设备在线才执行此操作(默认)

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.9. 重新上传考勤记录

支持的版本：v1.1.0 +

上传设备的考勤记录到系统，设备启用状态才允许操作。

Request:

POST /v1.0/device/reloadPunchRecord
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "startTime": 1492617600,
            "endTime": 1492790400,
            "onlineCheck": "1"
        }
    }
}
参数名 必填 描述
sn Y 设备编码
startTime Y 打卡开始Unix时间戳，精确到秒
endTime Y 打卡截止Unix时间戳，精确到秒
onlineCheck N 设备在线校验。0代表不校验设备状态，执行该操作，1代表设备在线才执行此操作(默认)

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

1.8.10. 同步所有人员到设备

支持的版本：v1.1.0 +

将系统的人员信息同步到设备，设备启用状态才允许操作。

Request:

POST /v1.0/hr/employee/device/refreshEmployeeInfo
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "33998400021314",
            "onlineCheck": "1"
        }
    }
}
参数名 必填 描述
sn Y 设备序列号
onlineCheck N 设备在线状态校验。0代表不校验设备状态，执行该操作，1代表设备在线才执行此操作(默认)

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success"
}

1.8.11. 登记指纹

支持的版本：v1.2.2 +

远程控制设备登记指纹，设备在接收到该指令后会提示登记指纹(有语音提示或窗口显示)，员工可直接根据相关提示进行登记。

使用须知:

  1. 此接口为部分设备才支持，支持的设备会返回执行成功的结果;
  2. 此接口一般是针对特殊设备才使用，如无屏机器;
  3. 针对一台设备，不可同时多个用户终端调用此接口，否则后面调用的会直接踢掉前面的会话;

Request:

POST /v1.0/device/registerFp
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "5900195100050",
            "employeeNo": "2956",
            "no": "",
            "isCover": "0"
        }
    }
}
参数名 是否必须 描述
sn 是 设备序列号
employeeNo 是 员工工号
no 否 指纹编号, 取值范围：0-9。
对应的手指是：左手：小拇指/无名指/中指/食指/拇指，右手：拇指/食指/中指/无名指/小拇指；为空时默认等于0
isCover 否 是否覆盖设备该指纹信息，0代表不覆盖（默认），1代表覆盖

Response：

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "results": {
            "sessionId": "xxxxxxxxxxxxxx"
        }
    }
}
参数名 描述
sessionId 会话唯一标识，每次登记指纹sessionId都不一致

1.8.12. 取消登记指纹

支持的版本：v1.2.2 +

与登记指纹匹配，在登记指纹过程中调用此接口，设备接收到该指令后会立即终止登记动作。

Request:

POST /v1.0/device/cancelRegisterFp
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "sn": "5900195100050"
        }
    }
}
参数名 是否必须 描述
sn 是 设备序列号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success"
}

results matching ""

    No results matching ""