Introduction to the REST API
The Rillsoft Integration Server is the integration and server layer of the Rillsoft platform. It exposes data and functionality from Rillsoft Project as a REST API – allowing projects, resources, workloads, vacations, documents, and dashboards to be consumed programmatically, without opening the fat client.
What can the REST API do?
- Read and write projects, tasks, clients, resources, and timesheet entries.
- DMS functions: store, download, and delete documents inside projects; manage folders.
- Vacation management: create, approve, or reject vacation requests.
- Dashboards: aggregated analytics as JSON for pie, line, and column charts.
- Authentication via username/password login with Bearer token or OAuth2 flow.
From SOAP web service to REST API
For a long time, the Rillsoft Integration Server interface was published as a SOAP web service: XML messages, WSDL contracts, generated stubs in Java or .NET. Reliable – but increasingly too heavyweight for modern web clients, mobile apps, and rapid integrations.
The first REST step arrived with the Rillsoft Android app: API v1 was developed as its backend – a lean REST layer next to the SOAP web service, focused on the needs of the mobile front-end.
With Rillsoft Project 10, the migration was completed: the entire integration layer was rebuilt on REST and shipped as API v2. JSON instead of XML envelopes, HTTP verbs (GET, POST, PUT, DELETE) instead of operation names, Bearer tokens instead of WS-Security – and a machine-readable OpenAPI specification as the single source of truth.
API v1 remains documented for the Android app and existing integrations. New connections should target v2 directly.
Which version should I use?
| Use case | Recommended version |
|---|---|
| New integration from Rillsoft Project 10 onwards | v2 |
| Rillsoft Android app | v1 |
| Maintaining an existing connection | v1 |
| Migrating from the SOAP web service | v2 |
| New mobile or web front-end | v2 |
What are the prerequisites?
- A reachable Rillsoft Integration Server instance (on-premises or cloud).
- Valid credentials for an API user.
- HTTPS client (cURL, Postman, any library).
- For regenerating the reference yourself:
openapi.jsonfrom the delivery.
This documentation helps you to
- understand the API structure and versioning.
- pick the right endpoints for an integration scenario.
- authenticate and call endpoints correctly.
- build your own integrations on top of the OpenAPI specification.
Next steps
- Jump straight to the API Reference.
- Install the server – see the Guides.