Перейти к основному содержимому

Glossary

Глоссарий терминов API HRlink

C

Client
Изолированное пространство (пространство клиента) внутри тенанта. Юрлица, пользователи и сотрудники принадлежат конкретному клиенту. Один клиент может объединять несколько юридических лиц.
Related terms: Tenant, LegalEntity, ClientUser
clientId
UUID пространства клиента. Присутствует в пути большинства API-эндпоинтов. Получается из ответа метода GET /api/v2/currentUser.
Related terms: Client
ClientUser
Связь пользователя с пространством клиента — пара (userId, clientId). Один пользователь может относиться к нескольким клиентам, но в одном клиенте встречается только один раз.
Related terms: User, Client, Employee

D

Department
Подразделение юрлица. Отделы образуют дерево: у каждого отдела есть parentDepartmentId. Корневой отдел создаётся автоматически при создании клиента.
Related terms: LegalEntity, Employee
DocumentSigningOrder
Порядок подписания документа: EMPLOYEE_FIRST (сотрудник, затем руководитель), MANAGER_FIRST (руководитель, затем сотрудник), EMPLOYEE_ONLY, MANAGER_ONLY или ROUTE (определяется маршрутом).
Related terms: SigningRouteTemplate

E

Employee
Связь пользователя пространства клиента с юрлицом — пара (clientUserId, legalEntityId). Один пользователь может иметь несколько записей Employee в разных юрлицах или даже в одном.
ESA (External System Authentication)
Сервис аутентификации внешних систем (esa.hr-link.ru). Через ESA интеграторы получают мастер-токены и реализуют сквозную аутентификацию.
Related terms: Master-Api-Token
externalId
Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID.
Related terms: id

F

functionalManager
Управленческий (функциональный) руководитель — назначается для конкретного сотрудника. Может быть из другого юрлица. Используется для матричных структур.
Related terms: headManager, Employee

H

headManager
Руководитель отдела — назначается на уровне подразделения (Department). Один руководитель на отдел. Все сотрудники отдела видят этого руководителя в своих данных.

I

id
Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях.
Related terms: externalId
Impersonation
Выполнение API-запросов от имени другого пользователя при использовании мастер-токена. Пользователь указывается через заголовки Impersonated-User-Id и Impersonated-User-Id-Type.
Related terms: Master-Api-Token

L

LegalEntity
Юридическое лицо в пространстве клиента. Содержит отделы и сотрудников. Один клиент может объединять несколько юрлиц — например, группу компаний.
Related terms: Client, Employee, Department
limit
Параметр пагинации — количество элементов в ответе. Значение по умолчанию — 50 (для отдельных эндпоинтов может отличаться).
Related terms: offset

M

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

O

offset
Параметр пагинации — смещение от начала списка. Значение по умолчанию — 0.
Related terms: limit

P

participantId
Уникальный идентификатор участника в маршруте подписания. Может измениться при обновлении маршрута — перед созданием документа всегда запрашивайте актуальные данные маршрута.
Related terms: SigningRouteTemplate
Position
Название должности из плоского справочника на уровне пространства клиента. Справочник общий для всех юрлиц. Position — именно название должности, а не позиция штатного расписания.
Related terms: Employee

S

SigningRouteTemplate
Шаблон маршрута подписания — определяет, кто, в каком порядке и каким способом подписывает документ. Содержит этапы (stages) с участниками (participants). Создаётся только через UI.
Substitution
Замещение — временная передача прав одного пользователя другому (например, на время отпуска). Настраивается для конкретных контекстов: документы, заявления, сотрудники, ЛНА.
Related terms: Employee

T

Tenant
Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов.
Related terms: Client

U

User
Физическое лицо в системе HRlink. Один User соответствует одному реальному человеку. С пользователем связаны персональные данные, документы (СНИЛС, паспорт, ИНН) и логины (email, телефон).
Related terms: ClientUser, Employee
User-Api-Token
Токен пользователя для аутентификации в API. Выпускается в UI кадровика, срок жизни — 1 год. Все запросы выполняются от имени пользователя-владельца токена.
Related terms: Master-Api-Token

V

version
Поле оптимистической блокировки (int64). При обновлении сущности передаётся текущее значение version — если данные были изменены параллельно, API вернёт ошибку конфликта.

К

КЭДО (Кадровый электронный документооборот)
Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.
Related terms: ЭДО

Л

ЛНА (Локальный нормативный акт)
Локальный нормативный акт — внутренний документ организации, с которым сотрудники знакомятся через HRlink. Управляется через отдельный набор API-методов.

М

МЧД (Машиночитаемая доверенность)
Машиночитаемая доверенность (Attorney) — электронный документ, подтверждающий полномочия представителя юридического лица.
Related terms: LegalEntity

П

печатная форма
PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения.
Related terms: ЭДО
ПЭП (Простая электронная подпись)
Простая электронная подпись (SES). Подтверждает факт подписания, но не гарантирует неизменность документа после подписания.
Related terms: УНЭП, УКЭП

У

УКЭП (Усиленная квалифицированная электронная подпись)
Усиленная квалифицированная электронная подпись (QES). Имеет полную юридическую силу. HRlink не хранит закрытый ключ — он находится на ПК пользователя.
Related terms: ПЭП, УНЭП
УНЭП (Усиленная неквалифицированная электронная подпись)
Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа.
Related terms: ПЭП, УКЭП

Э

ЭДО (Электронный документооборот)
Электронный документооборот — обмен юридически значимыми документами в электронном виде. HRlink реализует кадровый ЭДО (КЭДО): подписание трудовых документов электронными подписями вместо бумажных оригиналов.

Total terms: 32