REST API-Referenz für den Rillsoft Integration Server

REST API-Referenz

Die API-Referenz wird aus der OpenAPI-Spezifikation (openapi.json) des Rillsoft Integration Server generiert. Sie ist nach Versionen getrennt: v1 ist die ursprünglich für die Rillsoft-Android-App entwickelte REST-Schicht, v2 ist die mit Rillsoft Project 10 eingeführte vollwertige REST-Generation.

Versionen im Überblick

API v1 – entwickelt für die Rillsoft-Android-App

API v1 ist der erste REST-Schritt des Rillsoft Integration Server: gebaut speziell als Backend für die Rillsoft-Android-App, parallel zum damaligen SOAP-Webservice. Der Funktionsumfang ist entsprechend fokussiert auf das, was die mobile App braucht – Login, Mandanten, DMS-Downloads, Urlaubsverwaltung, Timesheets und Dashboard-Daten.

Diese Version bleibt für Kunden dokumentiert, die die Android-App weiter betreiben oder ihre frühen Bestandsintegrationen noch nicht auf v2 migriert haben.

→ Endpoints, Schemas und Standard-Antworten von API v1

API v2 – die REST-Generation mit Rillsoft Project 10

Mit Rillsoft Project 10 wurde die gesamte Integrationsschicht vom SOAP-Webservice auf REST umgestellt. API v2 ist das Ergebnis dieser Umstellung: vollständig in JSON, mit klar versionierter URL (/api/v2/...), Bearer-Token-Authentifizierung und durchgängiger OpenAPI-Beschreibung. Der Funktionsumfang erweitert sich kontinuierlich – DMS, Projekte, Ressourcen, Auslastung, Urlaubsverwaltung und Dashboards.

→ Endpoints, Schemas und Standard-Antworten von API v2

Wie lese ich diese Referenz?

• Endpoint-Seiten zeigen Methode, Pfad, Parameter, Request-Body, Response-Codes und Beispiel-Antworten.
• Schemas beschreiben die JSON-Datenstrukturen, die in Requests und Responses verwendet werden.
• Standard-Antworten (error-responses) sammeln wiederverwendete Fehlerformate aus components.responses.
• Pfad-Parameter listet die geteilten Path-Parameter aus components.parameters.

Welche Version sollte ich wählen?

Für neue Projekte ist API v2 die richtige Wahl. v1 wird ausschließlich für die Pflege bestehender Anbindungen weitergeführt und erhält keine neuen fachlichen Endpunkte.