REST API Documentation

REST API Documentation for the Rillsoft Integration Server

This documentation describes the official REST API of the Rillsoft Integration Server. It is aimed at administrators, integrators, and developers who connect Rillsoft Project to third-party systems, build their own front-ends, or automate existing processes.

What is the Rillsoft REST API?

The REST API is the official programming interface of the Rillsoft Integration Server. It exposes data from Rillsoft Project – projects, tasks, employees, workloads, vacations, DMS documents, and dashboards – via HTTPS endpoints in JSON. The complete technical contract is provided as an OpenAPI specification (openapi.json) and is the source of this reference.

From SOAP web service to REST API: a short history

For many years, the Rillsoft Integration Server exposed its interface as a classic SOAP web service: XML, WSDL, envelope-based calls. Functionally sufficient – but increasingly heavy for modern web and mobile clients.

The first REST step came with the Rillsoft Android app: API v1 was built specifically as the backend for it – a lean REST layer next to the SOAP web service, focused on exactly the endpoints the mobile front-end needed (login, clients, DMS downloads, vacations, timesheets, dashboard data).

With Rillsoft Project 10, the move was completed: the entire integration layer was migrated to REST and released as API v2. JSON instead of XML, clear HTTP verbs, Bearer-token authentication, and a continuous OpenAPI description. Today’s front-ends, mobile apps, BI tools, and automation platforms can connect directly – no SOAP stack required.

API v1 remains documented to support the Android app and existing integrations. API v2 is the strategic path and the recommended choice for every new integration.

What this documentation covers

• Introduction – purpose of the API, target audiences, place in the Rillsoft platform.
• API Reference – endpoint reference for v1 and v2, generated from openapi.json.
• Guides – installation of the Integration Server, authentication, typical integration scenarios.

Who is this documentation for?

• Administrators installing and operating the Integration Server.
• Integrators connecting Rillsoft Project to ERP, HR, BI, or DMS systems.
• Developers building front-ends, automations, or custom tools on top of the REST API.

Technical context