Документация REST API

Документация REST API сервера Rillsoft Integration Server

Эта документация описывает официальный REST API сервера Rillsoft Integration Server. Она предназначена для администраторов, интеграторов и разработчиков, которые подключают Rillsoft Project к сторонним системам, создают собственные интерфейсы или автоматизируют существующие процессы.

Что такое REST API Rillsoft?

REST API — это официальный программный интерфейс сервера Rillsoft Integration Server. Он предоставляет данные из Rillsoft Project — проекты, задачи, сотрудников, загрузку, отпуска, документы DMS и дашборды — через HTTPS-эндпоинты в формате JSON. Полное техническое описание поставляется в виде спецификации OpenAPI (openapi.json) и является источником данного справочника.

От SOAP-вебсервиса к REST API: краткая история

Долгое время программный интерфейс Rillsoft Integration Server поставлялся как классический SOAP-вебсервис: XML-сообщения, контракты WSDL, вызовы через envelope. Решение надёжное, но для современных веб- и мобильных клиентов всё более громоздкое.

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

С выходом Rillsoft Project 10 переход был завершён полностью: весь интеграционный слой переведён на REST и выпущен как API v2. JSON вместо XML, чёткие HTTP-методы, аутентификация по Bearer-токену и сквозное описание в OpenAPI. Современные фронтенды, мобильные приложения, BI-инструменты и платформы автоматизации подключаются напрямую — без SOAP-стека.

API v1 остаётся в документации для сопровождения Android-приложения и существующих интеграций. API v2 — стратегическое направление и рекомендуемый выбор для всех новых интеграций.

Содержание документации

• Введение — назначение API, целевые аудитории, место в платформе Rillsoft.
• Справочник API — справочник эндпоинтов v1 и v2, сгенерированный из openapi.json.
• Руководства — установка Integration Server, аутентификация, типовые сценарии интеграции.

Для кого эта документация?

• Администраторы, устанавливающие и эксплуатирующие Integration Server.
• Интеграторы, подключающие Rillsoft Project к ERP-, HR-, BI- или DMS-системам.
• Разработчики, создающие фронтенды, автоматизации или собственные инструменты на базе REST API.

Технические сведения