REST-API

Zweck der API

FLOWWER soll häufig in die bestehende Infrastruktur integriert werden. Um Drittsoftware effizient an FLOWWER anbinden zu können, haben wir jedem FLOWWER-Konto ein REST-API (Programmierschnittstelle) hinzugefügt.

Über das FLOWWER REST-API können Softwaresysteme ihre Daten direkt mit FLOWWER austauschen, ohne die grafische Benutzeroberfläche nutzen zu müssen. Besonders nützlich ist das, wenn eine Datenschnittstelle zur Anbindung an eine kundenspezifische Softwarelösung entwickelt werden soll.

Auch für einfache Aufgaben (z. B. den regelmäßigen Upload oder Download von Dokumenten) ist das FLOWWER REST-API sehr effizient.

API-Format

Das FLOWWER-API folgt der OpenAPI-Specification - einem Standard zur Beschreibung REST-konformer Programmierschnittstellen.

Damit wird die Nutzung von API-Tools wie z.B.

• HttpRepl
• Bruno
• Postman oder verschiedenen Client-Generatoren möglich.

Beschreibung der API

Jedes FLOWWER-Konto verfügt über eine eigene REST-API, welche unter Verwendung der FLOWWER-Kontokennung erreichbar ist.

Alle Funktionen der REST-API werden per ‘Swagger UI’ für den Browser sichtbar:

https://*Ihre-FLOWWER-Kontokennung*.flowwer.de/swagger

Das optionale FLOWWER-Feature „REST-API“ (früher „alternativer Download“) ermöglicht es, freigegebene Dokumente an weitere Ziele (zusätzlich zu DATEV Unternehmen Online) zu übertragen. Der Upload von Daten in das FLOWWER-System ist auch ohne Aktivierung des Features möglich.

Authentifizierung

Zugriffe auf die REST-API erfolgen mit dem API-Key eines API-Benutzers oder mit einem persönlichen REST-API-Token; Details unter Sicherheit.

Berechtigungen und Sichtbarkeit

Die REST-API arbeitet mit den Rechten des angemeldeten Benutzers bzw. API-Benutzers. Dokumente, die dieser Benutzer nach den Regeln der Sichtbarkeit von Dokumenten nicht sieht, liefert sie nicht aus.

Endpunkte, die ein einzelnes Dokument verändern, verlangen zusätzlich dasselbe Recht wie die entsprechende Aktion in der Benutzeroberfläche:

• Kommentar hinzufügen – Dokument sichtbar
• FiBu-Notiz ändern – zusätzlich FiBu-Notiz aktualisieren
• Dokumentdaten ändern – zusätzlich Dokumentdaten bearbeiten
• Ablehnen – zusätzlich Dokumente ablehnen
• Reaktivieren und Löschen abgelehnter Dokumente – Verantwortung für das abgelehnte Dokument (Abgelehnte Dokumente verwalten und unzugewiesene löschen)
• Floww zuweisen – Zuweisungsrecht für den Ziel-Floww
• Freigabe starten – Besitzer, Zuweisungsrecht oder Dokument-Administration
• Löschen ungestarteter Dokumente – Besitzer oder Verwaltung abgelehnter Dokumente

Fehlt die Sichtbarkeit oder das Recht, antwortet die API mit dem Status 403. Für die Export-Endpunkte freigegebener Dokumente (Download, „verarbeitet“ setzen) gelten weiterhin die Berechtigungen Freigegebene Dokumente auf alternativem Weg herunterladen bzw. Zugriff auf Freigegebene Dokumente.

Reporting über OData

Für schreibgeschützte Auswertungen in Excel, Power Query und Power BI steht zusätzlich der OData-Reporting-Endpunkt zur Verfügung. Über OData-Verbindung einrichten im Startmenü oder auf der Filterseite lassen sich die Verbindungsdaten erzeugen.

KI-Assistenten über MCP

Über den MCP-Server fragen KI-Assistenten FLOWWER-Daten lesend in natürlicher Sprache ab. Der MCP-Server muss in den Systemeinstellungen aktiviert werden.

Dokumente anhand eines Filterpfads finden

Ein auf der FLOWWER-Filterseite zusammengestellter Filterpfad kann über die Find-API für Filterpfade verwendet werden. Damit lassen sich passende Dokumente aus einer eigenen Integration heraus ermitteln und weiterverarbeiten.

Dokumentarchiv importieren und exportieren

Abgeschlossene Dokumentbestände können einschließlich ihrer Eigenschaften, Belegaufteilungen, Notizen und Protokolldaten als Archiv exportiert und wieder importiert werden.

Abwesenheitszeitpläne pflegen

Über die REST-API lassen sich Abwesenheitszeitpläne lesen und pflegen, etwa aus einem Personal- oder Urlaubsverwaltungssystem:

• GET, PUT und DELETE /api/v1/users/substitution-schedule – Zeitplan des angemeldeten Benutzers
• GET, PUT und DELETE /api/v1/users/{UserGuid}/substitution-schedule – Zeitplan eines anderen Benutzers; erfordert Benutzer verwalten

PUT ersetzt alle Einträge (höchstens 100) und übernimmt den Zeitplan sofort. Ungültige Einträge, z. B. ohne Vertretung oder mit überschneidenden Zeiträumen, weist die API mit dem Status 400 und den Fehlern je Eintrag zurück; für die Auswahl der Vertretung gelten dieselben Regeln wie in der Oberfläche.
DELETE beendet die Steuerung per Zeitplan; die aktuell hinterlegte Vertretung bleibt als einzelne Abwesenheit bestehen.