Введение в REST API
Rillsoft Integration Server — это интеграционный и серверный уровень платформы Rillsoft. Он предоставляет данные и функции Rillsoft Project через REST API: проекты, ресурсы, загрузку, отпуска, документы и дашборды становятся доступны программно, без открытия толстого клиента.
Что умеет REST API?
- Чтение и запись проектов, задач, клиентов, ресурсов и записей учёта времени.
- Функции DMS: загрузка, скачивание и удаление документов в проектах, управление папками.
- Управление отпусками: создание, утверждение и отклонение заявок на отпуск.
- Дашборды: агрегированная аналитика в JSON для круговых, линейных и столбчатых диаграмм.
- Аутентификация через вход по логину и паролю с Bearer-токеном или OAuth2-потоком.
От SOAP-вебсервиса к REST API
Долгое время интерфейс Rillsoft Integration Server публиковался как SOAP-вебсервис: XML-сообщения, контракты WSDL, сгенерированные stub-классы на Java или .NET. Решение проверенное, но для современных веб-клиентов, мобильных приложений и быстрых интеграций слишком тяжеловесное.
Первым шагом в сторону REST стало Android-приложение Rillsoft: для него был разработан API v1 — лёгкий REST-слой рядом с SOAP-вебсервисом, ориентированный на потребности мобильного фронтенда.
С Rillsoft Project 10 переход состоялся полностью: весь интеграционный слой пересобран на REST и выпущен как API v2. JSON вместо XML-envelope, HTTP-методы (GET, POST, PUT, DELETE) вместо имён операций, Bearer-токен вместо WS-Security — и машиночитаемая спецификация OpenAPI как единый источник истины.
API v1 остаётся в документации для Android-приложения и существующих интеграций. Новые подключения следует ориентировать сразу на v2.
Какую версию выбрать?
| Сценарий | Рекомендуемая версия |
|---|---|
| Новая интеграция начиная с Rillsoft Project 10 | v2 |
| Android-приложение Rillsoft | v1 |
| Сопровождение существующего подключения | v1 |
| Миграция с SOAP-вебсервиса | v2 |
| Новый мобильный или веб-фронтенд | v2 |
Какие нужны предпосылки?
- Доступная инстанция Rillsoft Integration Server (локально или в облаке).
- Действительные учётные данные API-пользователя.
- HTTPS-клиент (cURL, Postman, любая библиотека).
- Для самостоятельной генерации справочника:
openapi.jsonиз поставки.
Документация помогает
- понять структуру и версионирование API.
- выбрать нужные эндпоинты для сценария интеграции.
- корректно пройти аутентификацию и вызвать эндпоинт.
- собрать собственные интеграции на основе спецификации OpenAPI.
Следующие шаги
- Перейти прямо к Справочнику API.
- Установить сервер — см. Руководства.