Справочник REST API для Rillsoft Integration Server

Справочник REST API

Справочник API формируется из спецификации OpenAPI (openapi.json) сервера Rillsoft Integration Server. Он разделён по версиям: v1 — REST-слой, изначально разработанный для Android-приложения Rillsoft, v2 — полноценное поколение REST, появившееся с Rillsoft Project 10.

Обзор версий

API v1 — разработан для Android-приложения Rillsoft

API v1 — первый шаг Rillsoft Integration Server в сторону REST: создан специально как бэкенд для Android-приложения Rillsoft, параллельно с действовавшим тогда SOAP-вебсервисом. Объём функций соответствует тому, что нужно мобильному приложению: вход, клиенты, скачивание DMS, управление отпусками, табели и данные для дашбордов.

Версия остаётся в документации для клиентов, которые продолжают использовать Android-приложение или ещё не мигрировали ранние интеграции на v2.

→ Эндпоинты, схемы и стандартные ответы API v1

API v2 — поколение REST с Rillsoft Project 10

С выходом Rillsoft Project 10 весь интеграционный слой был переведён с SOAP-вебсервиса на REST. API v2 — итог этого перехода: полностью JSON, версионированные URL (/api/v2/...), аутентификация по Bearer-токену и сквозное описание в OpenAPI. Покрытие расширяется — DMS, проекты, ресурсы, загрузка, управление отпусками и дашборды.

→ Эндпоинты, схемы и стандартные ответы API v2

Как читать справочник?

• Страницы эндпоинтов показывают метод, путь, параметры, тело запроса, коды ответов и примеры ответов.
• Схемы описывают JSON-структуры данных, используемые в запросах и ответах.
• Стандартные ответы (error-responses) — переиспользуемые форматы ошибок из components.responses.
• Параметры пути — общие path-параметры из components.parameters.

Какую версию выбрать?

Для любых новых проектов правильный выбор — API v2. Версия v1 поддерживается исключительно для существующих интеграций и не получает новых функциональных эндпоинтов.