Схема процесса интеграции
...
Шаги процесса
| Table of Contents |
|---|
ШАГ 1. Загрузить доступные дни для планирования на год
Создать задачу массовой синхронизации данных
| Метод |
|---|
...
| Ссылка на документацию OpenAPI | |
|---|---|
POST https://{host}/api/v1/clients/{clientId}/bulkDataSyncTasks |
...
type = EMPLOYEE_VACATIONS_PLANNING |
Дополнительная информация
- Загрузить дни для планирования может как Администратор, так и Кадровик (Настройщик не может
) нужно ли это указывать ?- Пользователь должен иметь право BULK_DATA_SYNC_TASKS_CREATE на уровне пользователя клиента или на уровне активного сотрудника.
- Информация о доступных днях для планирования необходима для возможности планирования отпусков в HRlink.
Описание переменных
...
| Переменная | Описание | Обязательность |
|---|---|---|
tenantHost | Хост тенанта, на который должен быть выполнен запрос | да |
clientId | ИД клиента HRlink | да |
| externalId | Внешний идентификатор сотрудника.
|
...
| да | |
| legalEntityExternalId | Внешний идентификатор юрлица сотрудника. | нет |
| availableVacationsPlanning[] | Массив с данными для планирования.
| нет |
| planningYear | Год, на который будут планироваться отпуска | нет |
| basicVacationDayCount | Количество дней основного отпуска, доступных для планирования.
| нет |
| additionalVacationDayCount | Количество дней дополнительного отпуска, доступных для планирования.
| нет |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --location 'https://{{tenantHost}}/api/v1/clients/{{clientId}}/bulkDataSyncTasks' \
--header 'Impersonated-User-Id: {{clientUserExternalId}}' \
--header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
--data '{
"type": "CUSTOMEMPLOYEE_VACATIONS_STRUCTURESPLANNING",
"data": [
{
"externalId": "{{Внешний ИД сотрудника}}",
"legalEntityExternalId": "{{Внешний ИД юрлица}}",
"availableVacationsPlanning": [
{
"planningYear": 2026,
"basicVacationDayCount": 28,
"additionalVacationDayCount": 3
}
]
}
]
}' |
...
| No Format |
|---|
{
"result": true,
"bulkDataSyncTask": {
"id": "{{ИД задачи массовой синхронизации данных}}"
}
} |
...
ШАГ 1.1 Загрузить региональные календарей сотрудников
Опциональный шаг.
Если календари были загружены ранее и регулярно обновляются у сотрудников, то этот шаг можно пропустить.
Описать на отдельной странице.
- Загрузка календаря.
- Назначение календаря сотруднику.
Где используются календари в системе?
Разрешение планирования на год
Сотрудники планируют отпуска
ШАГ 2. Разрешить планирование отпусков на год
Установить состояние возможности планирования отпусков
| Метод | Ссылка на документацию OpenAPI |
|---|---|
PUT https://{host}/api/v1/clients/{clientId}/vacations/setPlanningState | https://docs.myhrlink.ru/public/openapi/hr-link/#tag/vacationScheduleManage/operation/setPlanningState |
Дополнительная информация
- Разрешить планирование может только как Администратор.
- Пользователь должен иметь право VACATIONS_CHANGE_PLANNING_STATE на уровне пользователя клиента или на уровне активного сотрудника.
Описание переменных
| Переменная | Описание | Обязательность |
|---|---|---|
tenantHost | Хост тенанта, на который должен быть выполнен запрос | да |
clientId | ИД клиента HRlink | да |
| planningState | Состояние планирования отпусков в системе HRlink. Может принимать два состояния:
| да |
| planningYear | Год, на который устанавливается настройка планирования.
| нет |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --request PUT \
--url 'https://{{tenantHost}}/api/v1/clients/{clientId}/vacations/setPlanningState?planningState=ENABLED&planningYear=2026' \
--header 'Impersonated-User-Id: {{clientUserExternalId}}' \
--header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
--header 'master-api-token: master_token_value
|
Пример ответа
| No Format |
|---|
{
"result": true
} |
ШАГ 3. Выгрузить спланированные отпуска
Установить состояние возможности планирования отпусков
| Метод | Ссылка на документацию OpenAPI |
|---|---|
PUT https://{host}/api/v1/clients/{clientId}/vacations/setPlanningState | https://docs.myhrlink.ru/public/openapi/hr-link/#tag/vacationScheduleManage/operation/setPlanningState |
Дополнительная информация
- Разрешить планирование может только как Администратор.
- Пользователь должен иметь право VACATIONS_CHANGE_PLANNING_STATE на уровне пользователя клиента или на уровне активного сотрудника.
Описание переменных
| Переменная | Описание | Обязательность |
|---|---|---|
tenantHost | Хост тенанта, на который должен быть выполнен запрос | да |
clientId | ИД клиента HRlink | да |
| planningState | Состояние планирования отпусков в системе HRlink. Может принимать два состояния:
| да |
| planningYear | Год, на который устанавливается настройка планирования.
| нет |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --request PUT \
--url 'https://{{tenantHost}}/api/v1/clients/{clientId}/vacations/setPlanningState?planningState=ENABLED&planningYear=2026' \
--header 'Impersonated-User-Id: {{clientUserExternalId}}' \
--header 'Impersonated-User-Id-Type: EXTERNAL_ID' \
--header 'master-api-token: master_token_value
|
Пример ответа
| No Format |
|---|
{
"result": true
} |
Загрузка отпусков из внешней системы в HRlinkРуководители согласуют
Загрузка отпусков из внешней системы в HRlink
...