Einführung in die REST API des Rillsoft Integration Server

Einführung in die REST API

Der Rillsoft Integration Server ist die Integrations- und Serverebene der Rillsoft Plattform. Er stellt Daten und Funktionen von Rillsoft Project als REST API bereit – damit lassen sich Projekte, Ressourcen, Auslastungen, Urlaube, Dokumente und Dashboards programmatisch nutzen, ohne den Fat Client zu öffnen.

Was leistet die REST API?

• Lesen und Schreiben von Projekten, Vorgängen, Mandanten, Ressourcen und Zeitbuchungen.
• DMS-Funktionen: Dokumente in Projekten ablegen, herunterladen, löschen, Ordner verwalten.
• Urlaubsverwaltung: Urlaubsanträge anlegen, genehmigen oder ablehnen.
• Dashboards: Aggregierte Auswertungen als JSON für Pie-, Line- und Column-Charts.
• Authentifizierung per Username/Passwort-Login mit Bearer-Token oder OAuth2-Flow.

Vom SOAP-Webservice zur REST API

Lange Zeit wurde die Programmierschnittstelle des Rillsoft Integration Server als SOAP-Webservice veröffentlicht: XML-Nachrichten, WSDL-Verträge, generierte Stubs in Java oder .NET. Solide, aber für moderne Web-Clients, mobile Apps und schnelle Integrationen zunehmend zu schwergewichtig.

Der erste REST-Schritt entstand mit der Rillsoft-Android-App: für sie wurde API v1 entwickelt – ein schlanker REST-Aufsatz neben dem SOAP-Webservice, ausgerichtet auf die Bedürfnisse des mobilen Frontends.

Mit Rillsoft Project 10 wurde der Schritt vollständig vollzogen: die gesamte Integrationsschicht wurde auf REST umgestellt und als API v2 ausgeliefert. JSON statt XML-Envelope, HTTP-Verben (GET, POST, PUT, DELETE) statt Operation Names, Bearer-Token statt WS-Security – und vor allem eine maschinenlesbare OpenAPI-Spezifikation als Quelle der Wahrheit.

API v1 bleibt für die Android-App und bestehende Integrationen dokumentiert. Neue Anbindungen sollten direkt auf v2 aufsetzen.

Welche Version sollte ich nutzen?

Welche Voraussetzungen sind nötig?

• Eine erreichbare Rillsoft Integration Server-Instanz (lokal oder in der Cloud).
• Gültige Anmeldedaten für einen API-Benutzer.
• HTTPS-Client (cURL, Postman, beliebige Bibliothek).
• Bei eigener Generierung der Referenz: openapi.json aus der Auslieferung.

Diese Dokumentation hilft beim

• Verstehen der API-Struktur und Versionierung.
• Auswählen der richtigen Endpunkte für ein Integrationsszenario.
• Authentifizieren und korrekten Aufrufen der Endpunkte.
• Aufbau eigener Integrationen auf Basis der OpenAPI-Spezifikation.

Nächste Schritte

• Direkt in die API-Referenz wechseln.
• Den Server installieren – siehe Anleitungen.