1.7.1. 员工信息同步

员工基本信息同步接口请求

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "lastName": "lin",
            "firstName": "huiwu",
            "formattedName": "huiwu.lin",
            "active": 1,
            "photo": "http://zkteco.com/test.jpg",
            "gender": "1",
            "email": "luther.lin@zkteco.com",
            "phone": "",
            "hireDate": "2019-06-03",
            "organization": ["org_01", "org_02"],
            "devicePermission": "0",
            "deviceVerifyMode": "0",
            "devicePassword": "",
            "facePhoto": "http://zkteco.com/test.jpg",
            "cardNo": "",
            "lastUpdateTimeStamp": 1557910639
        }
    }
}
参数名 必填 描述
employeeNo Y 员工编号
lastName Y 姓
firstName Y 名
formattedName Y 格式化后的姓名，用于显示
active Y 状态，1代表正常，0代表软删除
photo N 档案照, 支持URL(http/https)和base64
gender N 性别, 1代表男性，2代表女性，3代表其他
email N 邮箱地址
phone N 联系电话、手机号码
hireDate N 雇佣(入职)日期
organization N 所属组织架构编码列表
devicePermission N 员工在设备的权限，0:普通员工(默认), 14:管理员
deviceVerifyMode N 验证方式，默认=0，详见验证方式说明
devicePassword N 员工设备密码，若不开启员工密码打卡，建议当员工是管理员时才设置员工设备密码
facePhoto N 人脸照片，用于人脸比对，支持URL(http/https)和base64
cardNo N 卡号
lastUpdateTimeStamp Y 第三方最后修改时间戳，若该时间戳小于或等于上一次该组织架构接收到的时间戳，则该数据不处理，但会返回成功编码

注意事项：

  1. 同步员工信息之前，需先同步组织架构;
  2. 本接口对非必填的属性，仅需要传入需要改动的属性，当不包含某个属性key值时，表示此属性不变动。 比如，只修改了该员工基础信息，组织架构、设备信息、比对照片、卡号等都不变，则入参为
    {
 "lang": "zh-cn",
 "usr": "username",
 "pwd": "password",
 "payload": {
     "params": {
         "employeeNo": "2956",
         "lastName": "lin",
         "firstName": "huiwu",
         "formattedName": "huiwu.lin",
         "active": 1,
         "photo": "http://zkteco.com/test.jpg",
         "gender": "1",
         "email": "luther.lin@zkteco.com",
         "phone": "",
         "hireDate": "2019-06-03",
         "lastUpdateTimeStamp": 1557910639
     }
 }
}

Response：

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

1.7.2. 员工信息同步(批量)

Request:

POST /v1.0/hr/employees/sync
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employees": [{
                "employeeNo": "2956",
                "lastName": "lin",
                "firstName": "huiwu",
                "formattedName": "huiwu.lin",
                "active": 1,
                "photo": "http://zkteco.com/test.jpg",
                "gender": "1",
                "email": "",
                "phone": "",
                "hireDate": "2019-06-03",
                "organization": ["org_01", "org_02"],
                "devicePermission": "0",
                "deviceVerifyMode": "0",
                "devicePassword": "",
                "facePhoto": "http://zkteco.com/test.jpg",
                "cardNo": "",
                "lastUpdateTimeStamp": 1557910639
            }]
        }
    }
}

相关参数描述及注意事项参考员工信息同步

注意

若同步的批量数据有涉及到照片，建议单条同步，或者单独调用照片同步接口。

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": [{
            "employeeNo": "2956",
            "code": "00000000",
            "message": "success"
        }]
    }
}

1.7.3. 删除员工信息

第三方调用接口删除员工信息，系统会自动将此员工从关联的设备中移除。

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "员工编号",
            "lastUpdateTimeStamp": 1557910639
        }
    }
}
参数名 必填 描述
employeeNo Y 员工编号
lastUpdateTimeStamp Y 第三方最后修改时间戳，若该时间戳小于或等于上一次该员工收到的时间戳，则该数据不处理，但会返回成功编码

Response：

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

1.7.4. 删除员工信息(批量)

第三方调用接口删除员工信息，系统会自动将此员工从关联的设备中移除。

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employees": [{
                "employeeNo": "员工编号",
                "lastUpdateTimeStamp": 1557910639
            }]
        }
    }
}

相关参数描述及注意事项参考删除员工信息

Response：

{
    "code": "00000000",
    "mid": "xxxxxxx",
    "message": "success",
    "payload": {
        "results": [{
            "employeeNo": "员工编号",
            "code": "执行结果编码",
            "message": "执行结果描述"
        }]
    }
}

1.7.5. 人脸照片同步

人脸比对照片同步，此照片用于提取用户人脸生物识别模板，以便使用人脸打卡

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "facePhoto": "http://test.com/2956.jpg"
        }
    }
}
参数名 必填 描述
employeeNo Y 员工编号
facePhoto N 人脸照片，用于人脸比对，支持URL(http/https)和base64

Response：

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

1.7.6. 查询员工核验信息

支持的版本：v1.1.1 +

查询员工核验信息接口请求

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956"
        }
    }
}
参数名 必填 描述
employeeNo Y 员工编号

Response：

{
    "code": "00000000",
    "mid": "xxx",
    "message": "success",
    "payload": {
        "result": {
            "facePhotoCount": 0,
            "fingerCount": 1,
            "faceCount": 0,
            "devicePermission": "14",
            "cardNo": "421343",
            "devicePassword": "41341",
            "deviceVerifyMode": "0"
        }
    }
}
参数名 描述
facePhotoCount 可见光人脸数
fingerCount 指纹数
faceCount 面部（近红外人脸）数
devicePermission 员工在设备的权限，0:普通员工(默认), 14:管理员
cardNo 卡号
devicePassword 员工设备密码
deviceVerifyMode 验证方式，详见验证方式说明

1.7.7. 删除员工生物模板信息

支持的版本：v1.1.1 +

删除员工生物模板信息接口请求

Request:

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

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "params": {
            "employeeNo": "2956",
            "type": "1"
        }
    }
}
参数名 必填 描述
employeeNo Y 员工编号
type Y 生物特征类别，详见生物特征类别说明

Response：

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

results matching ""

    No results matching ""