# 开放接口API说明-员工帐号接口
# 新增员工帐号
请求方式: POST(HTTPS)
请求地址: https://{region}/api/employee/v2/addEmployee/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
emp_id | VARCHAR(32) | 是 | 来源第三方系统的员工唯一标识 |
emp_code | VARCHAR(100) | 是 | 员工登录帐号,必须唯一,不区分大小写,有效字符详见附录:有效字符说明 (opens new window) |
emp_password | VARCHAR(32) | 是 | 员工登录帐号密码 |
force_modify_password | CHAR(1) | 否 | 首次登录客户端是否强制修改密码。1:强制修改,0:不强制修改。默认值为1 |
emp_name | VARCHAR(100) | 是 | 姓名,不为空,有效字符详见附录:有效字符说明 (opens new window) |
emp_sex | CHAR(1) | 是 | 员工性别。F:女性,M:男性。默认值为M |
emp_mobile | VARCHAR (12) | 否 | 员工手机号码,默认值:11111111111 |
emp_tel | VARCHAR (13) | 否 | 固定电话,示例:025-68736873 |
emp_idcard | VARCHAR(20) | 否 | 身份证号码 |
emp_birthday | CHAR(10) | 否 | 生日。格式:yyyy-MM-dd |
emp_email | VARCHAR(100) | 否 | 邮箱 |
emp_addr | VARCHAR(500) | 否 | 地址 |
emp_qq | VARCHAR(100) | 否 | |
emp_weixin | VARCHAR(100) | 否 | 微信 |
emp_org_id | VARCHAR(32) | 否 | 隶属部门,来源第三方系统的部门ID,参考部门信息接口中的org_id字段说明 |
waiqin365_org_id | VARCHAR(32) | 否 | 勤策中部门唯一标识ID, waiqin365_org_id,emp_org_id如果同时存在优先取waiqin365_org_id,二者不能同时为空 |
emp_is_org_learder | CHAR(1) | 是 | 是否部门领导。0:否,1:是。默认值为0 |
waiqin365_parent_id | VARCHAR(32) | 否 | 勤策上级唯一ID,waiqin365_parent_id,emp_parent_id如果同时存在优先取waiqin365_parent_id |
emp_parent_id | VARCHAR(32) | 否 | 来源第三方系统的员工上级唯一标识,和员工信息接口中的emp_id字段相对应,填写正常状态的数据 |
emp_imsi_binding | CHAR(1) | 是 | 账号绑定手机卡。0:不绑定,1:绑定。默认值为1 |
emp_position | VARCHAR(100) | 否 | 职务名称 |
emp_job | VARCHAR(100) | 否 | 岗位名称 |
emp_status | CHAR(1) | 是 | 员工账号状态。0:销户,1:正常,2:停用。默认值为1 |
emp_roles | VARCHAR(500) | 否 | 同步员工角色名称,多个角色用“,”分割,如:“考勤员,员工(系统)”。 默认开通角色为:员工(系统) |
emp_products | VARCHAR(500) | 否 | 同步员工开通的产品名称,多个产品用“,”分割,如:“商贸版,定位版”。 默认不开通产品。注:同步开通的只能是企业已经订购的产品,且订购产品总人数未超上限 |
emp_model | VARCHAR(100) | 否 | 开通定位版时指定定位组名称 |
dealer_waiqin365_id | VARCHAR(100) | 否 | 勤策经销商的id,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低。不传不存,传空字符串则更新为空 |
dealer_id | VARCHAR(100) | 否 | 经销商的第三方id,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低。不传不存,传空字符串则更新为空 |
dealer_code | VARCHAR(100) | 否 | 经销商的编码,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低。不传不存,传空字符串则更新为空 |
residence_ids | VARCHAR(100) | 否 | 所驻门店 |
emp_baseprovince | VARCHAR(100) | 否 | 常驻地省信息 |
emp_basecity | VARCHAR(100) | 否 | 常驻地市信息 |
emp_attendance_group | VARCHAR(100) | 否 | 指定员工考勤组名称 |
emp_wechat_code | VARCHAR(32) | 否 | 来源企微员工唯一标识。只有企微同步过来的人员该字段才有值 |
cover_mobile_auth | CHAR(1) | 否 | 是否覆盖手机认证。0:不覆盖,1:覆盖。默认值为0。当值为1时手机号必填,如果该手机号在系统内已存在,已存在的手机号将被替换为11111111111,并将手机认证变更为未认证状态 |
auth_channel | VARCHAR(32) | 否 | 鉴权通道 |
emp_enrollment_time | CHAR(10) | 否 | 入职时间。格式:yyyy-MM-dd |
emp_resignation_time | CHAR(10) | 否 | 离职时间。格式:yyyy-MM-dd |
exts | List | 否 | 扩展字段列表 |
exts.ext_key | VARCHAR(1000) | 否 | 扩展字段名称 |
exts.ext_value | VARCHAR(1000) | 否 | 扩展字段值 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
异常示例:
{
"msg_id": "X000001",
"return_code": 100201,
"return_msg": "员工唯一标识已经存在!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 修改员工帐号
请求方式: POST(HTTPS)
请求地址: https://{region}/api/employee/v2/modifyEmployee/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
emp_id | VARCHAR(32) | 否 | 来源第三方系统的员工唯一标识,和勤策员工唯一标识不能同时为空,emp_id、id如果同时存在优先取id |
id | VARCHAR(32) | 否 | 勤策员工唯一标识,和第三方系统的员工唯一标识不能同时为空, emp_id、id如果同时存在优先取id |
emp_code | VARCHAR(100) | 否 | 员工登录帐号,唯一,有效字符详见附录:有效字符说明 (opens new window) |
emp_password | VARCHAR(32) | 否 | 员工登录帐号密码 |
force_modify_password | CHAR(1) | 否 | 首次登录客户端是否强制修改密码。1:强制修改,0:不强制修改。默认值为1 |
emp_name | VARCHAR(100) | 否 | 姓名,不为空,有效字符详见附录:有效字符说明 (opens new window) |
emp_sex | CHAR(1) | 否 | 员工性别。F:女性,M:男性。默认值为M |
emp_mobile | VARCHAR (12) | 否 | 员工手机号码,默认值:11111111111 |
emp_tel | VARCHAR(13) | 否 | 固定电话,示例:025-68736873 |
emp_idcard | VARCHAR(20) | 否 | 身份证号码 |
emp_birthday | CHAR(10) | 否 | 生日。格式:yyyy-MM-dd |
emp_email | VARCHAR(100) | 否 | 邮箱 |
emp_addr | VARCHAR(500) | 否 | 地址 |
emp_qq | VARCHAR(100) | 否 | |
emp_weixin | VARCHAR(100) | 否 | 微信 |
emp_org_id | VARCHAR(32) | 否 | 来源第三方系统的部门ID |
waiqin365_org_id | VARCHAR(32) | 否 | 勤策中部门唯一标识ID,emp_org_id、waiqin365_org_id如果同时存在优先取waiqin365_org_id |
emp_is_org_learder | CHAR(1) | 否 | 是否部门领导。0:否,1:是。默认值为0 |
emp_parent_id | VARCHAR(32) | 否 | 来源第三方系统的员工上级唯一标识,有效字符详见附录:有效字符说明 (opens new window),填写正常状态的数据 |
waiqin365_parent_id | VARCHAR(32) | 否 | 勤策员工上级唯一标识, 和emp_parent_id同时存在时优先取waiqin365_parent_id值 |
emp_imsi_binding | CHAR(1) | 否 | 手机卡绑定。0:不绑定,1:绑定。默认值为1 |
emp_position | VARCHAR(100) | 否 | 职务名称 |
emp_job | VARCHAR(100) | 否 | 岗位名称 |
emp_status | CHAR(1) | 否 | 员工账号状态。0:销户,1:正常,2:停用。默认值为1 |
emp_roles | VARCHAR(500) | 否 | 同步员工角色名称,多个角色用“,”分割,如:“考勤员,员工(系统)”。 默认开通角色为:员工(系统) |
emp_products | VARCHAR(500) | 否 | 同步员工开通的产品名称,多个产品用“,”分割,如:“商贸版,定位版”。注:若传值则修改该字段值;不传值则清空该字段值。同步开通的只能是企业已经订购的产品,且订购产品总人数未超上限 |
emp_model | VARCHAR(100) | 否 | 开通定位版时指定定位组名称 |
dealer_waiqin365_id | VARCHAR(100) | 否 | 勤策经销商的id,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低,不传不存,传空字符串则更新为空 |
dealer_id | VARCHAR(100) | 否 | 经销商的第三方id,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低,不传不存,传空字符串则更新为空 |
dealer_code | VARCHAR(100) | 否 | 经销商的编码,dealer_waiqin365_id、dealer_id、dealer_code如果同时存在,优先级依次降低,不传不存,传空字符串则更新为空 |
residence_ids | VARCHAR(100) | 否 | 所驻门店 |
emp_baseprovince | VARCHAR(100) | 否 | 常驻地省信息 |
emp_basecity | VARCHAR(100) | 否 | 常驻地市信息 |
emp_attendance_group | VARCHAR(100) | 否 | 设置员工考勤组名称 |
emp_wechat_code | VARCHAR(32) | 否 | 来源企微员工唯一标识。只有企微同步过来的人员该字段才有值 |
emp_enrollment_time | CHAR(10) | 否 | 入职时间。格式:yyyy-MM-dd |
emp_resignation_time | CHAR(10) | 否 | 离职时间。格式:yyyy-MM-dd |
exts | List | 否 | 扩展字段列表 |
exts.ext_key | VARCHAR(1000) | 否 | 扩展字段名称 |
exts.ext_value | VARCHAR(1000) | 否 | 扩展字段值 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
异常示例:
{
"msg_id": "X000001",
"return_code": 100205,
"return_msg": "员工唯一标识不存在"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。 其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 删除员工帐号
请求方式: POST(HTTPS)
请求地址: https://{region}/api/employee/v2/removeEmployee/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
emp_id | VARCHAR(32) | 否 | 第三方系统员工唯一标识,和勤策员工唯一ID不能同时为空 |
id | VARCHAR(32) | 否 | 勤策员工唯一ID,和第三方系统员工唯一标识不能同时为空,id、emp_id如果同时存在优先取id |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 查询员工帐号
请求方式: POST(HTTPS)
请求地址: https://{region}/api/employee/v2/queryEmployee/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(19) | 否 | 根据来源勤策的员工唯一标识精确查询 |
emp_id | VARCHAR(32) | 否 | 根据来源第三方系统的员工唯一标识精确查询,id、emp_id如果同时存在优先取id |
emp_code | VARCHAR(100) | 否 | 根据员工登录帐号精确查询 |
emp_name | VARCHAR(100) | 否 | 根据姓名模糊查询 |
emp_status | CHAR(1) | 否 | 根据员工状态查询 |
create_date | CHAR(10) | 否 | 根据创建日期查询用户。格式:yyyy-MM-dd |
modify_date | CHAR(10) | 否 | 根据修改日期查询用户。格式:yyyy-MM-dd |
emp_mobile | VARCHAR(32) | 否 | 根据手机号查询 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id": "6526123236734933062",
"emp_id": "YG0001",
"emp_code": "zs",
"emp_name": "张三",
"last_use_time": "2017-09-09 13:14:11",
"emp_sex": "M",
"emp_mobile": "13122222223",
"emp_idcard": "",
"emp_email": "zhangsan@waiqin365.com",
"emp_addr": "南京市建邺区云龙山路88号",
"emp_org_id": "ORG001",
"emp_org_code": "DD001",
"waiqin365_org_id": "6415931465210350521",
"emp_parent_id": "YD0002",
"parent_code": "lb",
"waiqin365_parent_id": "8479750039739139535",
"emp_is_org_learder": "false",
"emp_status": "1",
"emp_imsi_binding": 1,
"create_time": "2017-09-09 13:14:11",
"modify_time": "2018-09-09 13:14:11",
"dealer_id": "7037900608674473059",
"dealer_name": "家乐福建业店",
"emp_baseprovince": "安徽省",
"emp_basecity": "合肥市",
"waiqin365_position_id":"7247618738553344855",
"emp_position_code":"12345678",
"emp_position":"测试",
"waiqin365_job_id":"8924298880233554809",
"emp_job_code":"2",
"emp_job":"kaifa",
"emp_wechat_code": "1241241214",
"emp_enrollment_time": "2022-02-26",
"emp_resignation_time": "2022-02-27",
"mobile_auth": "0",
"exts": [
{
"ext_column":"ext20220",
"ext_key": "文本框",
"ext_value": ""
},
{
"ext_column":"ext20221",
"ext_key": "单选",
"ext_value": ""
},
{
"ext_column":"ext20222",
"ext_key": "下拉框",
"ext_value": "选项1"
},
{
"ext_column":"ext20223",
"ext_key": "考勤ID号",
"ext_value": ""
}
]
}
]
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(32) | 是 | 勤策的员工唯一标识 |
emp_id | VARCHAR(32) | 否 | 来源第三方系统的员工唯一标识 |
emp_code | VARCHAR(100) | 是 | 员工登录帐号 |
emp_name | VARCHAR(100) | 是 | 姓名 |
last_use_time | VARCHAR(10) | 否 | 最近登录时间。格式:yyyy-MM-dd HH:mm:ss |
emp_sex | CHAR(1) | 是 | 员工性别。F:女性,M:男性 |
emp_mobile | VARCHAR(12) | 是 | 员工手机号码 |
emp_tel | VARCHAR(13) | 否 | 固定电话,示例:025-68736873 |
emp_idcard | VARCHAR(20) | 否 | 身份证号码 |
emp_birthday | CHAR(10) | 否 | 生日。格式:yyyy-MM-dd |
emp_email | VARCHAR(100) | 否 | 邮箱 |
emp_addr | VARCHAR(500) | 否 | 地址 |
emp_qq | VARCHAR(100) | 否 | |
emp_weixin | VARCHAR(100) | 否 | 微信 |
emp_wechat_code | VARCHAR(32) | 否 | 来源企微员工唯一标识。只有企微同步过来的人员该字段才有值 |
emp_org_id | VARCHAR(100) | 否 | 来源第三方系统隶属部门 |
emp_org_code | VARCHAR(100) | 是 | 隶属部门编码 |
waiqin365_org_id | VARCHAR(32) | 是 | 勤策中部门唯一标识ID, waiqin365_org_id,emp_org_id,emp_org_code如果同时存在优先取waiqin365_org_id,emp_org_id,emp_org_code。其次三者不能同时为空 |
emp_is_org_learder | CHAR(1) | 是 | 是否机构领导。0:否,1:是 |
emp_parent_id | VARCHAR(100) | 否 | 来源第三方系统,员工上级唯一标识 |
parent_code | VARCHAR(100) | 否 | 员工上级编码 |
waiqin365_parent_id | VARCHAR(32) | 否 | 勤策员工上级唯一标识 |
emp_imsi_binding | CHAR(1) | 是 | 手机卡绑定。0:不绑定,1:绑定 |
waiqin365_position_id | VARCHAR(64) | 否 | 勤策职务唯一标识 |
emp_position_code | VARCHAR(100) | 否 | 职务编码 |
emp_position | VARCHAR(100) | 否 | 职务名称 |
waiqin365_job_id | VARCHAR(64) | 否 | 勤策岗位唯一标识 |
emp_job_code | VARCHAR(100) | 否 | 岗位编码 |
emp_job | VARCHAR(100) | 否 | 岗位名称 |
emp_status | CHAR(1) | 是 | 员工账号状态。0:销户,1:正常,2:停用 |
create_time | VARCHAR(32) | 否 | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
modify_time | VARCHAR(32) | 否 | 修改时间。格式:yyyy-MM-dd HH:mm:ss |
dealer_id | VARCHAR(100) | 否 | 勤策经销商唯一标识 |
dealer_name | VARCHAR(100) | 否 | 经销商中文名称 |
emp_baseprovince | VARCHAR(100) | 否 | 常驻地省信息 |
emp_basecity | VARCHAR(100) | 否 | 常驻地市信息 |
emp_enrollment_time | CHAR(10) | 否 | 入职时间。格式:yyyy-MM-dd |
emp_resignation_time | CHAR(10) | 否 | 离职时间。格式:yyyy-MM-dd |
mobile_auth | VARCHAR(32) | 否 | 手机认证,0为是,1为否 |
exts | List | 否 | 扩展字段列表 |
exts.ext_column | VARCHAR(1000) | 否 | 扩展字段的字段名称 |
exts.ext_key | VARCHAR(1000) | 否 | 扩展字段名称 |
exts.ext_value | VARCHAR(1000) | 否 | 扩展字段值 |
# 推送员工数据
勤策平台在员工基础信息发生变化时向第三方系统推送数据接口
请求方式: POST(HTTPS)
请求地址: 第三方服务接口URL
请求参数:
参数名称 | 参数值 |
---|---|
msgId | 消息ID |
dataId | 数据ID |
dataVersion | 接口数据版本,如:001 |
dataFormat | 数据格式:json |
dataSource | 数据来源。biz:业务功能产生,api:开放接口产生 |
timestamp | 请求时间戳,如:1503276678552 |
status | 数据同步状态。0:数据首次同步,2:数据失败同步 |
statusTime | 上次同步失败时间。格式:yyyy-MM-dd HH:mm:ss |
tenantId | 企业ID,各注册企业在勤策中对应的唯一ID |
digest | 数据签名,md5(data|pushsecret|timestamp) |
dataType | employee 员工 |
data | <<请求数据体>> ,说明:格式为JSON格式数据 |
请求数据体:
{
"id": "8563826803527594225",
"emp_code": "zs",
"emp_name": "张三",
"emp_mobile": "18000000016",
"emp_idcard": "",
"waiqin365_org_id": "4868022188434416233",
"emp_parent_id": "EMP0001",
"emp_parent_code ": "zhangsan",
"waiqin365_parent_id": "9031907337842765652",
"emp_is_org_learder": "0",
"emp_sex": "F",
"emp_email": "zs@waiqin365.com",
"emp_addr": "江苏省南京市建邺区嘉陵江东街50号",
"emp_weixin": "",
"emp_tel": "",
"emp_imsi_binding": "0",
"emp_status": "1",
"emp_qq": "",
"dealer_id": "7037900608674473059",
"dealer_name": "家乐福建业店",
"emp_baseprovince": "安徽省",
"emp_basecity": "合肥市",
"emp_org_id": "ORG001",
"emp_enrollment_time": "2022-02-26",
"emp_resignation_time": "2022-02-27",
"emp_wechat_code": "emp001",
"exts": [
{
"ext_key": "自定义字段1",
"ext_value": "value1"
},
{
"ext_key": "自定义字段2",
"ext_value": "value2"
}
]
}
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(32) | 是 | 勤策的员工唯一标识 |
emp_id | VARCHAR(32) | 否 | 来源第三方系统的员工唯一标识 |
emp_code | VARCHAR(100) | 是 | 员工登录帐号,必须唯一,有效字符详见附录:有效字符说明 (opens new window) |
emp_name | VARCHAR(100) | 是 | 姓名,唯一,有效字符详见附录:有效字符说明 (opens new window) |
emp_sex | CHAR(1) | 是 | 员工性别。F:女性,M:男性。默认值为M |
emp_mobile | VARCHAR (12) | 否 | 员工手机号码,默认值:11111111111 |
emp_tel | VARCHAR (13) | 否 | 固定电话,示例:025-68736873 |
emp_idcard | VARCHAR(20) | 否 | 身份证号码 |
emp_birthday | CHAR(10) | 否 | 生日。格式:yyyy-MM-dd |
emp_email | VARCHAR(100) | 否 | 邮箱 |
emp_addr | VARCHAR(500) | 否 | 地址 |
emp_qq | VARCHAR(100) | 否 | |
emp_weixin | VARCHAR(100) | 否 | 微信 |
emp_org_id | VARCHAR(32) | 是 | 隶属部门,来源第三方系统的部门ID,参考部门信息接口中的org_id字段说明 |
waiqin365_org_id | VARCHAR(32) | 是 | 隶属部门,勤策中部门唯一ID |
emp_is_org_learder | CHAR(1) | 是 | 是否部门领导。0:否,1:是。默认值为0 |
emp_parent_id | VARCHAR(32) | 否 | 来源第三方系统的员工上级唯一标识,和员工信息接口中的emp_id字段相对应 |
waiqin365_parent_id | VARCHAR(32) | 否 | 勤策中员工上级唯一ID |
emp_parent_code | VARCHAR(32) | 否 | 勤策中员工上级编码 |
emp_imsi_binding | CHAR(1) | 是 | 账号绑定手机卡,0不绑定 1绑定。默认值:1 |
emp_position | VARCHAR(100) | 否 | 职务名称 |
emp_job | VARCHAR(100) | 否 | 岗位名称 |
emp_status | CHAR(1) | 是 | 员工账号状态。0:销户,1:正常,2:停用。默认值为1 |
emp_wechat_code | VARCHAR(32) | 否 | 来源企微员工唯一标识。只有企微同步过来的人员该字段才有值 |
exts | List | 否 | 扩展字段列表 |
exts.ext_key | VARCHAR(1000) | 否 | 扩展字段名称 |
exts.ext_value | VARCHAR(1000) | 否 | 扩展字段值 |
dealer_id | VARCHAR(100) | 否 | 勤策经销商唯一标识 |
dealer_name | VARCHAR(100) | 否 | 经销商中文名称 |
emp_baseprovince | VARCHAR(100) | 否 | 常驻地省信息 |
emp_basecity | VARCHAR(100) | 否 | 常驻地市信息 |
emp_enrollment_time | CHAR(10) | 否 | 入职时间。格式:yyyy-MM-dd |
emp_resignation_time | CHAR(10) | 否 | 离职时间。格式:yyyy-MM-dd |
响应示例:
{
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | String | 响应说明 |