REST API-Dokumentation

REST API-Dokumentation des Rillsoft Integration Server

Diese Dokumentation beschreibt die offizielle REST API des Rillsoft Integration Server. Sie richtet sich an Administratoren, Integratoren und Entwickler, die Rillsoft Project mit Drittsystemen verbinden, eigene Oberflächen entwickeln oder bestehende Prozesse automatisieren wollen.

Was ist die Rillsoft REST API?

Die REST API ist die offizielle Programmierschnittstelle des Rillsoft Integration Server. Sie liefert Daten aus Rillsoft Project – Projekte, Vorgänge, Mitarbeiter, Auslastungen, Urlaube, DMS-Dokumente und Dashboards – über HTTPS-Endpunkte im JSON-Format. Die vollständige technische Definition liegt als OpenAPI-Spezifikation (openapi.json) vor und ist die Quelle dieser Referenz.

Vom SOAP-Webservice zur REST API: kurze Geschichte

Über viele Jahre wurde die Schnittstelle des Rillsoft Integration Server als klassischer SOAP-Webservice ausgeliefert. XML, WSDL, Envelope-basierte Aufrufe – funktional ausreichend, aber für moderne Web- und Mobile-Clients schwerfällig.

Der erste REST-Schritt erfolgte mit der Rillsoft-Android-App: für sie wurde API v1 entwickelt – ein schlanker REST-Aufsatz neben dem SOAP-Webservice, fokussiert auf genau die Endpunkte, die das mobile Frontend brauchte (Login, Mandanten, DMS-Downloads, Urlaube, Timesheets, Dashboard-Daten).

Mit Rillsoft Project 10 wurde der Schritt vollständig vollzogen: die gesamte Integrationsschicht wurde auf REST umgestellt und als API v2 veröffentlicht. JSON statt XML, klare HTTP-Verben, Bearer-Token-Authentifizierung und eine durchgängige OpenAPI-Beschreibung. Heutige Frontends, mobile Anwendungen, BI-Tools und Automatisierungs-Plattformen lassen sich ohne SOAP-Stack direkt anbinden.

API v1 bleibt zur Wartung der Android-App und bestehender Integrationen dokumentiert. API v2 ist die strategische Schiene und für alle neuen Integrationen empfohlen.

Inhalt dieser Dokumentation

• Einführung – Aufgabe der API, Zielgruppen, Einordnung in die Rillsoft Plattform.
• API-Referenz – generierte Endpoint-Referenz für v1 und v2 auf Basis von openapi.json.
• Anleitungen – Installation des Integration Server, Authentifizierung, typische Integrationsszenarien.

Für wen ist diese Dokumentation gedacht?

• Administratoren, die den Integration Server installieren und betreiben.
• Integratoren, die Rillsoft Project an ERP-, HR-, BI- oder DMS-Systeme anbinden.
• Entwickler, die Frontends, Automatisierungen oder eigene Tools auf Basis der REST API bauen.

Technische Einordnung