Об этой документации

Публичное API HRlink используют, чтобы синхронизировать сотрудников и оргструктуру, отправлять документы и заявления на подписание, получать статусы и скачивать подписанные файлы.

Документация рассчитана на разработчиков и интеграторов, которые подключают HRlink к 1С, HR-системам, порталам самообслуживания или внутренним сервисам компании. Чтобы начать, достаточно знать REST, HTTP и JSON.

Что вы хотите сделать

Задача	С чего начать
Проверить доступ к API	Первый запрос
Разобраться с базовыми URL, clientId, ответами и пагинацией	Обзор API
Выбрать способ аутентификации	Аутентификация
Настроить продакшн-интеграцию через мастер-токенMaster-Api-Token Мастер-токен для M2M-интеграций. Позволяет выполнять запросы от имени любого пользователя системы через заголовки Impersonated-User-Id. Получается через ESA с помощью сертификата интегратора.	Мастер-токен
Получить мастер-токенMaster-Api-Token Мастер-токен для M2M-интеграций. Позволяет выполнять запросы от имени любого пользователя системы через заголовки Impersonated-User-Id. Получается через ESA с помощью сертификата интегратора. из 1С	Получение мастер-токена из 1С
Синхронизировать сотрудников и оргструктуру	Синхронизация сотрудников
Отправить документ на подписание	Отправка документов на подписание
Получать статусы подписания	Отслеживание статусов
Работать с заявлениями	Заявления
Работать с доверенностями	Работа с доверенностями
Настроить вход пользователя в HRlink из внешней системы	Сквозная аутентификация
Найти ошибку по коду	Коды ошибок

Минимальный путь до первого запроса

1. Получите tenantHost и токен аутентификации.
2. Вызовите Текущий пользователь.
3. Возьмите clientId из currentUser.clientUsers[].client.id.
4. Вызовите Получить сотрудников с limit=10 и offset=0.

Пошаговый пример с curl, PowerShell и HTTP-запросом смотрите в разделе Первый запрос.

Перед проектированием интеграции

Прочитайте эти разделы до разработки, чтобы сразу выбрать правильные идентификаторы, права и способ обновления данных:

• Модель данных — user, clientUser, employee, legalEntity и связи между ними
• Идентификаторы — когда использовать id, а когда externalId
• Аутентификация — как выбрать User-Api-Token, мастер-токенMaster-Api-Token Мастер-токен для M2M-интеграций. Позволяет выполнять запросы от имени любого пользователя системы через заголовки Impersonated-User-Id. Получается через ESA с помощью сертификата интегратора. или сквозной вход
• Роли и права доступа — какие данные увидит пользователь, от имени которого выполняется запрос
• Работа с файлами — загрузка через multipart/form-data, скачивание файлов и типичные ошибки
• Ограничения и лимиты — rate limiting, размеры файлов, bulk-операции и пагинация

Частые сценарии

Сценарий	Разделы
Первичная загрузка оргструктуры	Синхронизация сотрудников, Модель данных, Идентификаторы
Отправка документов сотрудникам	Отправка документов, Маршруты подписания, Подписи
Отслеживание завершения подписания	Отслеживание статусов, Документы, Коды ошибок
Заявления сотрудников	Заявления, Заявления и документы, Комментарии
Массовые операции	Массовые операции, Ограничения и лимиты

API Reference

• HRlink API — методы для работы с сотрудниками, документами, заявлениями, файлами, маршрутами, доверенностями и справочниками
• ESA API — методы для мастер-токеновMaster-Api-Token Мастер-токен для M2M-интеграций. Позволяет выполнять запросы от имени любого пользователя системы через заголовки Impersonated-User-Id. Получается через ESA с помощью сертификата интегратора. и сквозной аутентификации

Если в документации нет нужного сценария или поведение метода отличается от описания, напишите в чат по API и интеграциям.