1.4.2.1. 创建公司
- 创建公司是调用所有业务接口的基础,所有业务数据均需归属与某一公司,创建公司成功后会返回集成账户信息。
- 集成账户将于后续业务接口调用时校验权限使用,请务必妥善保存。
Request:
POST /v1.0/hr/company/create
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"payload": {
"params": {
"companyCode": "公司编码",
"companyName": "公司名称",
"countryCode": "CN",
"province": "福建",
"city": "厦门",
"address1": "街道1",
"address2": "街道2",
"address3": "街道3",
"logo": "公司logo",
"website": "",
"zip": "邮编",
"phone": "公司联系电话",
"email": "公司邮箱",
"industry": "所属行业",
"dateFormat": "yyyy-MM-dd",
"timeFormat": "HH:mm:ss",
"active": 1,
"lastUpdateTimeStamp": 1557910639
}
}
}
参数名 | 类型 | 必填 | 描述 |
---|---|---|---|
companyCode | String | Y | 公司编码,可理解为第三方系统内公司唯一标识 |
companyName | String | Y | 公司名称 |
String | Y | 公司联系邮箱 | |
lastUpdateTimeStamp | Long | Y | 最后修改时间戳,即当前调用该接口的时间,以后修改公司信息用此判断是否做处理 |
countryCode | String | N | 公司所属国家编码,参考标准的国家代码,默认CN |
province | String | N | 公司所属省 |
city | String | N | 公司所属市 |
address1 | String | N | 街道1 |
address2 | String | N | 街道2 |
address3 | String | N | 街道3 |
logo | String | N | 公司logo,可下载的图片URL http 或 https地址 |
website | String | N | 公司网址 |
zip | String | N | 邮编 |
phone | String | N | 公司联系电话 |
industry | String | N | 所属行业 |
dateFormat | String | N | 日期格式,用于界面日期格式显示,默认yyyy-MM-dd |
timeFormat | String | N | 时间格式,用于界面时间格式显示,默认HH:mm:ss |
active | Integer | N | 状态,1代表正常,0代表软删除, 默认1 |
Response:
{
"code": "00000000",
"message": "成功",
"mid": "f3ca72c2ebb14ece83aabe35a9e804a4",
"payload": {
"results": {
"apiUser": {
"password": "0fLXHu",
"userName": "dbs5@zkteco.com"
}
}
}
}
参数名 | 类型 | 描述 |
---|---|---|
apiUser | Object | 集成账户,接口调用时企业租户安全保障。 |
userName | String | 账号 |
password | String | 密码 |
注意:
集成账户优先默认使用企业邮箱,若遇到用户名冲突,则会随机生成,一般是邮箱的前缀+随机数字。
1.4.2.2. 修改公司信息
Request:
POST /v1.0/hr/company/update
Content-Type: application/json
Authorization: ACCESS_TOKEN
Timestamp: 1529223702
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"params": {
"companyName": "公司名称",
"countryCode": "CN",
"province": "福建",
"city": "厦门",
"address1": "公司地址",
"address2": "公司地址",
"address3": "公司地址",
"logo": "公司logo",
"website": "",
"zip": "邮编",
"phone": "公司联系电话",
"email": "公司邮箱",
"industry": "所属行业",
"dateFormat": "yyyy-MM-dd",
"timeFormat": "HH:mm:ss",
"active": 1,
"lastUpdateTimeStamp": 1557910639
}
}
}
相关参数描述及注意事项参考创建公司信息
Response::
{
"code": "00000000",
"mid": "消息id",
"message": "返回错误码描述"
}