Сценарии работы Сотрудника с Документами
О чём раздел
Под сценариями работы Сотрудника понимаем:
Просмотр данных документа, в т.ч. получение архива КЭДО
- Подписание документа: УНЭП, УКЭП, ПЭП, в т.ч. подписание со стороны работодателя и согласование документа участниками документооборота
- Отклонение документа
1. Сотрудник просматривает данные документа
Цель
Предоставить сотруднику всю необходимую информацию по кадровому документу
Предусловие - авторизация произведена
при использовании мастер-токена
с помощью логина/пароля
по коду
Или используется токен пользователя
Действия и API-методы | Примечание |
|---|---|
1) Получение списка документов для Сотрудника (с учётом фильтров) REDOC POST /api/v1/clients/:clientId/documents/employeeRegistry | |
2) Получение данных документа по ID в своей ИС REDOC GET /api/v1/clients/:clientId/documents/:externalId/externalId или GET /api/v1/clients/:clientId/documents/:documentId | Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется сохранить идентификатор документа в HRlink |
3) Получение печатной формы документа с оттиском REDOC GET /api/v1/clients/:clientId/documents/:documentId/printFormFile |
2. Сотрудник подписывает (согласовывает) документ через УНЭП по коду из сообщения
Цель
Подписать документ, со стороны Сотрудника, как работника компании
Предусловие - выполнен сценарий 1
Действия и API-методы | Примечание |
|---|---|
1) Запуск подписания УНЭП - запрос сообщения с кодом REDOC POST /api/v1/clients/:clientId/documents/:documentId/sign/nqes | По итогу вызова данного метода требуется отобразить форму ввода кода |
2) Завершение подписания УНЭП - подтверждение кода из сообщения REDOC PUT /api/v1/clients/:clientId/documents/:documentId/sign/nqes | В данный метод передается код, который направляется в сообщении |
3) Получение данных документа по ID в своей ИС REDOC GET /api/v1/clients/:clientId/documents/:externalId/externalId или GET /api/v1/clients/:clientId/documents/:documentId
| Подписание документа - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние документа, чтобы:
Подробнее о том, как понять состояние документа см. раздел Объекты и связи. Документ Дополнительный метод Получить данные запроса на подписание документа (УНЭП, Госключ, ПРР) позволяет получить подробную информацию о состоянии подписания документа. |
4) Получение печатной формы документа с оттиском REDOC GET /api/v1/clients/:clientId/documents/:documentId/printFormFile | Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется идентификатор документа в HR-link |
3. Сотрудник отклоняет документ, ожидающий подписания (согласования)
Цель
Передать информацию Кадровику о причине отклонения документа
Предусловие - выполнен сценарий 1
Действия и API-методы | Примечание |
|---|---|
1) Отказ от подписания документа REDOC PUT /api/v1/clients/:clientId/documents/:documentId/rejectSigning | Для отклонения подписания обязательным является указание причины - передача не пустого текстового поля, требуется получить от сотрудника текст причины отклонения |
2) Получение данных документа по ID в своей ИС REDOC GET /api/v1/clients/:clientId/documents/:externalId/externalId или GET /api/v1/clients/:clientId/documents/:documentId | Рекомендуется запрашивать состояние документа, чтобы получить обновление по статусу |
4. Сотрудник запрашивает Архив КЭДО по документу
Цель
Предоставить Сотруднику все артефакты КЭДО в рамках данного документа, а именно:
оригинал файла, который подписывался
печатную форму с оттисками
файлы подписи, если есть
Предусловие - выполнен сценарий 1
Действия и API-методы | Примечание |
|---|---|
1) Запрос архива документооборота по ID в своей ИС REDOC GET /api/v1/clients/:clientId/documents/:externalId/externalId/archive или GET /api/v1/clients/:clientId/documents/:documentId/archive | Скачать архив документооборота можно на любом этапе. В архиве документооборота файлы подписи могут отсутствовать, если документ еще никто не подписал. |
5. Сотрудник подписывает (согласовывает) документ УКЭП
Цель
Подписать (согласовать) документ со стороны работодателя или его представителя.
Предусловие:
- Известен идентификатор документа для подписания
- Если при подписании используется МЧД, то идентификатор МЧД должен быть известен - подробнее см. раздел МЧД (раздел находится в процессе) 03. Объекты и связи#03.%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B%D0%B8%D1%81%D0%B2%D1%8F%D0%B7%D0%B8-%D0%9C%D0%A7%D0%94(%D0%9C%D0%B0%D1%88%D0%B8%D0%BD%D0%BE%D0%A7%D0%B8%D1%82%D0%B0%D0%B5%D0%BC%D0%B0%D1%8F%D0%94%D0%BE%D0%B2%D0%B5%D1%80%D0%B5%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D1%8C)
Действия и API-методы | Примечание |
|---|---|
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) Сотрудник подписывает документ ПЭП с помощью портала Работа в России REDOC POST /api/v2/clients/{clientId}/documents/{documentId}/sign/prr |
7. Сотрудник подписывает (согласовывает) документ ПЭП HRlink
Цель
Подписать (согласовать) документ со стороны другого согласующего Сотрудника
Предусловие - Известен идентификатор документа для подписания
Действия и API-методы | Примечание |
|---|---|
1) Сотрудник подписывает документ ПЭП HRlink REDOC PUT /api/v1/clients/:clientId/documents/:documentId/sign/ses |
Поиск документации