В данном разделе 


REST API - "Запрос-Ответ"

Для Интеграции HRlink предоставляет доступ к API в рамках тенанта Клиента.

Для передачи в HRlink и для получения информации из HRlink необходимо использовать REST API.

Система HRlink только отправляет ответы на запросы, поэтому для получения актуальной информации о состоянии объектов (документы, заявления, сотрудники и т.д.) на стороне Клиента необходимо реализовывать периодические опросы HRlink, для получения обновлённой информации.

Асинхронные процессы

Большая часть событий имеет синхронный формат процесса, однако некоторые из событий являются ассинхронными.

Нужно учитывать, что выполнение асинхронных событий может занимать какое-то время.

  1. Конвертация файла в формат PDF/A
  2. Выпуск УНЭП
  3. Создание документа с совмещённой отправкой
  4. Подписание 
  5. Обновление печатной формы с оттиском

ExternalId

 Большая часть объектов имеет двойной идентификатор

  • ID - идентификатор, формируемый HRlink в формате UUID
  • ExternalId - для HRlink это идентификатор внешней системы, для Клиента это идентификатор в своей системе

Поддержка двойных идентификаторов позволяет Клиенту обращаться к объектам наиболее удобным образом.

Пагинация

 Получение реестров (Документы, Заявления, Сотрудники) происходит с учётом пагинации.

При запросе списков (реестр документов, заявлений, сотрудников и т.д.) HRlink используется постраничный вывод.

Параметры в теле запроса

```
{
    "sort": [{ "by": "DOCUMENT_DATE", "direction": "ASC" }],
    "limit": 50,
    "offset": 1324
}
```

пояснение

  • 50 - максимальное значение, по умолчанию = 10

Получая список документов, нужно посмотреть количество документов в списке,

  • Переопределение сдвига offset = offset + limit

Таким образом каждый раз вычисляется новый сдвиг, например:

  • Итерация 1: limit = 50, offset = 0 (или не указан)
    • Получили первые 50 заявлений
  • Итерация 2: limit = 50, offset = 50
    • Получили заявления с 51 по 100
  • Итерация 3: limit = 50, offset = 100
    • Получили заявления со 101 по 150
  • Итерация N - полученное количество заявлений меньше 50, следовательно дошли до конца списка заявлений, дальнейший инкремент сдвига не требуется

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

Недавно обновлённые страницы