Сценарии работы Сотрудника с Документами


Под сценариями работы Сотрудника понимаем:

  1. Просмотр данных документа, в т.ч. получение архива КЭДО

  2. Подписание документа: УНЭП, УКЭП, ПЭП, в т.ч. подписание со стороны работодателя и согласование документа участниками документооборота
  3. Отклонение документа


 1. Сотрудник просматривает данные документа

Предоставить сотруднику всю необходимую информацию по кадровому документу

Предусловие - авторизация произведена

Или используется токен пользователя


Действия и API-методы

Примечание

1) Получение списка документов для Сотрудника (с учётом фильтров) 

POST /api/v1/clients/:clientId/documents/employeeRegistry


2) Получение данных документа по идентификатору документа в ИС клиента 

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

 

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

3) Получение печатной формы документа с оттиском

GET /api/v1/clients/:clientId/documents/:documentId/printFormFile



2. Сотрудник подписывает (согласовывает) документ через УНЭП по коду из сообщения

Подписать документ, со стороны Сотрудника, как работника компании

Предусловие - выполнен сценарий 1


Действия и API-методы

Примечание

1) Запуск подписания УНЭП - запрос сообщения с кодом

POST /api/v1/clients/:clientId/documents/:documentId/sign/nqes

По итогу вызова данного метода сотруднику будет выслан код на его подтвержденный канал получения кода подписания. Требуется отобразить форму для ввода кода


2) Завершение подписания УНЭП - подтверждение кода из сообщения

PUT /api/v1/clients/:clientId/documents/:documentId/sign/nqes

В данный метод передается код, который направляется в сообщении

3) Получение данных документа по идентификатору документа в ИС клиента 

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

 

Подписание документа - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние документа, чтобы:

  1. получить обновление по статусу

  2. перейти к запросу печатной формы с оттиском

Подробнее о том, как понять состояние документа см. раздел Объекты и связи. Документ

Дополнительный метод Получить данные запроса на подписание документа (УНЭП, Госключ, ПРР) позволяет получить подробную информацию о состоянии подписания документа.

4) Получение печатной формы документа с оттиском

GET /api/v1/clients/:clientId/documents/:documentId/printFormFile

Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется идентификатор документа в HR-link


3. Сотрудник отклоняет документ, ожидающий подписания (согласования)

Отклонить документ (отказаться от подписания документа) и передать информацию Кадровику о причине отклонения документа

Предусловие - выполнен сценарий 1


Действия и API-методы

Примечание

1) Отказ от подписания документа

PUT /api/v1/clients/:clientId/documents/:documentId/rejectSigning

Для отклонения подписания обязательным является указание причины - передача не пустого текстового поля, требуется получить от сотрудника текст причины отклонения

2) Получение данных документа по идентификатору документа в ИС клиента 

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

Рекомендуется запрашивать состояние документа, чтобы получить обновление по статусу


4. Сотрудник запрашивает Архив КЭДО по документу

Предоставить Сотруднику все артефакты КЭДО в рамках данного документа, а именно:

  • оригинал файла, который подписывался

  • печатную форму с оттисками

  • файлы подписи, если есть

Предусловие - выполнен сценарий 1



Действия и API-методы

Примечание

1) Запрос архива документооборота по идентификатору документа в ИС клиента

GET /api/v1/clients/:clientId/documents/:externalId/externalId/archive

или

GET /api/v1/clients/:clientId/documents/:documentId/archive

Скачать архив документооборота можно на любом этапе. 

В архиве документооборота файлы подписи могут отсутствовать, если документ еще никто не подписал.


5. Сотрудник подписывает (согласовывает) документ УКЭП

Подписать (согласовать) документ со стороны работодателя или его представителя.

Предусловие:


Действия и API-методы

Примечание

1) Сотрудник подписывает документ УКЭПом (прикладывает файл подписи, сформированный во вне HRlink) по идентификатору документа в ИС клиента

PUT /api/v2/clients/{clientId}/documentsByExternalId/{documentId}/signByQes

PUT /api/v2/clients/{clientId}/documents/{documentId}/signByQes

Устаревший метод:

PUT /api/v1/clients/:clientId/documents/:documentId/sign/externalQes


Перед подписанием (вызовом метода) необходимо сформировать файл подписи документа вне системы HRlink и приложить этот файл в формате base64, которая содержит бинарные данные подписи созданной с помощью УКЭП.




6. Сотрудник подписывает (согласовывает) документ ПЭП Госуслуги

Подписать (согласовать) документ со стороны другого согласующего Сотрудника через портал Работа России

Предусловие - Известен идентификатор документа для подписания


Действия и API-методы

Примечание

1) Сотрудник подписывает документ ПЭП с помощью портала Работа в России

POST /api/v2/clients/{clientId}/documents/{documentId}/sign/prr




7. Сотрудник подписывает (согласовывает) документ ПЭП HRlink

Подписать (согласовать) документ со стороны другого согласующего Сотрудника

Предусловие - Известен идентификатор документа для подписания


Действия и API-методы

Примечание

1) Сотрудник подписывает документ ПЭП HRlink 

PUT /api/v1/clients/:clientId/documents/:documentId/sign/ses






Поиск документации