| Table of Contents |
|---|
Сценарии работы Сотрудника с Документами
| Tipexcerpt | ||
|---|---|---|
| ||
... |
| Note | ||
|---|---|---|
| ||
... |
API-методы
Примечания
POST /api/v1/clients/:clientId/legalEntities
Создавать ЮЛ может только пользователь с ролью Администратор
При создании можно указать Идентификатор ЮЛ в ИС Клиента, через поле externalId, это позволит в дальнейшем использовать внутренний (с точки зрения Клиента) идентификатор для работы с ЮЛ.
POST /api/v1/clients/:clientId/departments
|
| Table of Contents |
|---|
- Создание МЧД
или - Импорт МЧД
Сценарий
Действия и API-методы
Примечание
1. Сотрудник просматривает данные документа
| Tip | ||
|---|---|---|
|
Предоставить сотруднику всю необходимую информацию по кадровому документу Предусловие - авторизация произведена
Или используется токен пользователя |
Действия и API-методы | Примечание | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Получение списка документов для Сотрудника (с учётом фильтров) POST /api/v1/clients/:clientId/documents/employeeRegistry | На момент составления описания данные метод не оформлен в API-документации Работа метода (входные параметры для фильтрации и результаты выполнения метода) аналогичны методу получение списка документов для Кадровика (с учётом фильтров) | ||||||||
ИС клиента 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. Сотрудник подписывает (согласовывает) документ через УНЭП по коду из сообщения
Цель - подписать| Tip | ||
|---|---|---|
| ||
Подписать документ, со стороны Сотрудника, как работника компании Предусловие - выполнен сценарий 1 |
Действия и API-методы | Примечание | |||||||
|---|---|---|---|---|---|---|---|---|
1) Запуск подписания УНЭП - запрос сообщения с кодом POST /api/v1/clients/:clientId/documents/:documentId/sign/nqes |
По итогу вызова данного метода |
сотруднику будет выслан код на его подтвержденный канал получения кода подписания. Требуется отобразить форму для ввода кода | ||||||||
2) Завершение подписания УНЭП - подтверждение кода из сообщения
PUT /api/v1/clients/:clientId/documents/:documentId/sign/nqes |
В данный метод передается код, который направляется в сообщении |
ИС клиента |
GET /api/v1/clients/:clientId/documents/:documentId |
| Подписание документа - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние документа, чтобы:
Подробнее о том, как понять состояние документа см. раздел |
Дополнительный метод Получить данные запроса на подписание документа (УНЭП, Госключ, ПРР) позволяет получить подробную информацию о состоянии подписания документа. |
4) |
Получение печатной формы документа с оттиском GET /api/v1/clients/:clientId/documents/:documentId/printFormFile | Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется идентификатор документа в HR-link |
3. Сотрудник отклоняет документ, ожидающий подписания (согласования)
| Tip | ||
|---|---|---|
|
Отклонить документ (отказаться от подписания документа) и передать информацию Кадровику о причине отклонения документа Предусловие - выполнен сценарий 1 |
Действия и API-методы | Примечание | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1) Отказ от подписания документа PUT /api/v1/clients/:clientId/documents/:documentId/rejectSigning | Для отклонения подписания обязательным является указание причины - передача не пустого текстового поля, требуется получить от сотрудника текст причины отклонения | ||||||||||||||||
| ID своей ИС клиента GET /api/v1/clients/:clientId/documents/:externalId/externalId или
GET /api/v1/clients/:clientId/documents/:documentId | рекомендуется Рекомендуется запрашивать состояние документа, чтобы получить обновление по статусу |
4. Сотрудник запрашивает Архив КЭДО по документу
Цель - предоставить| Tip | ||
|---|---|---|
| ||
Предоставить Сотруднику все |
артефакты КЭДО в рамках данного документа, а именно:
Предусловие - выполнен сценарий 1 |
Действия и API-методы | Примечание | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID своей ИС
GET /api/v1/clients/:clientId/documents/:externalId/externalId/archive или
GET /api/v1/clients/:clientId/documents/:documentId/archive | Скачать архив документооборота можно на любом этапе. В архиве документооборота файлы подписи файла документа могут отсутствовать, может быть одна подпись, и может быть обе подписи. Это зависит от того, кто подписал документ на момент скачивания архива документооборотаесли документ еще никто не подписал. |
5. Сотрудник подписывает (согласовывает) документ УКЭП
| Tip | ||
|---|---|---|
|
Подписать (согласовать) документ со стороны работодателя или его представителя. Предусловие:
|
Действия и 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. Сотрудник подписывает (согласовывает) документ ПЭП Госуслуги
| Tip | ||
|---|---|---|
| ||
Подписать (согласовать) документ со стороны другого согласующего Сотрудника через портал Работа России Предусловие - Известен идентификатор документа для подписания |
Действия и API-методы | Примечание | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Сотрудник подписывает документ ПЭП с помощью портала Работа в России POST /api/ v2/clients/ {clientId}/documents/ {documentId}/sign/prr На момент составления описания данные метод не оформлен в API-документации |
7. Сотрудник подписывает (согласовывает) документ ПЭП HRlink
| Tip | ||
|---|---|---|
| ||
Подписать (согласовать) документ со стороны другого согласующего Сотрудника Предусловие - Известен идентификатор документа для подписания |
Действия и API-методы | Примечание | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Сотрудник подписывает документ ПЭП HRlink PUT /api/v1/clients/:clientId/documents/:documentId/sign/ses |
Поиск документации
| Livesearch | ||
|---|---|---|
|