基础接口¶
获取企业的基本信息¶
使用场景：该接口用于获取企业企业信息，包括企业名称、企业全称、企业简称等。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/company/info/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "d22ba6*****f44c7a89ae*****19c7f5",
"company_no": "AF02P",
"fullname": "美丽人生科技有限公司",
"shortname": "美人"
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 企业ID |
| company_no | 企业识别码 |
| fullname | 企业名称 |
| shortname | 企业简称 |
获取归属集团下所有的企业列表¶
使用场景：该接口用于获取集团下所有子企业信息，包括企业名称、企业全称、企业简称
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/group/company_list/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": [
{
"id": "d22ba6*****f44c7a89ae*****19c7f5",
"company_no": "AF02P",
"shortname": "美丽人生科技有限公司",
"fullname": "美丽人生科技有限公司"
},
{
"id": "a149cc*****14b32990c8*****b420ef",
"company_no": "AF02P",
"shortname": "潇洒人生科技有限公司",
"fullname": "潇洒人生科技有限公司"
}
]
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 企业ID |
| company_no | 企业识别码 |
| fullname | 企业名称 |
| shortname | 企业简称 |
获取企业的合同公司列表¶
使用场景：该接口用于获取企业合同公司列表，包括合同公司名称、合同公司简称、合同公司法人等。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/company/contract_company/list/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": [
{
"id": "fb90fe****1409885176****a1785f",
"fullname": "成都美丽人生分公司",
"shortname": "成美",
"legal_person": "贾似真",
"contact_name": "贾似真",
"address": "四川/成都/青阳区/光华东三路601号"
},
{
"id": "2c6f7a*****d4a899a5ea*****385196",
"fullname": "深圳美丽人生分公司",
"shortname": "深美",
"legal_person": "贾似真",
"contact_name": "贾似真",
"address": "广东/深圳/福田区/梅林街道501号"
}
]
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 合同公司ID |
| fullname | 合同公司名称 |
| shortname | 合同公司简称 |
| legal_person | 合同公司法人名称 |
| contact_name | 合同公司联系人 |
| address | 合同公司地址 |
获取流程ID¶
使用场景：该接口通过人员的手机号(mobile)来获取entry_id，该entry_id可能对应该人员在某个企业的一次合同签署流程的记录或者入职登记流程记录。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/base/get_entry_id/?access_token=ACCESS_TOKEN&mobile=XXX
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| mobile | String | 是 | 人员的手机号 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"entry_id": "fb90fe****1409885176****a1785f"
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| entry_id | 流程ID |
创建合同公司¶
使用场景：该接口用于创建合同公司，可在入职时选择。
请求方式：POST（HTTPS）
请求地址：https://openapi.2haohr.com/api/company/contract_company/create/?access_token=ACCESS_TOKEN
请求示例：
[
{
"name": "2号合同公司",
"short_name": "2号",
"legal_person": "小明",
"contact_name": "小明",
"address": "四川/成都/青阳区/光华东三路601号"
}
]
参数说明：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| name | 是 | 合同公司名称 |
| short_name | 否 | 合同公司简称 |
| legal_person | 否 | 合同公司法人名称 |
| contact_name | 否 | 合同公司联系人 |
| address | 否 | 合同公司地址 |
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": [
{
"id": "eac3eea1126f4b52b04eaaed21892409",
"name": "2号合同公司"
}
]
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 合同公司id |
| name | 合同公司名称 |