Das ist eine für den Ausdruck optimierte Ansicht des gesamten Kapitels inkl. Unterseiten. Druckvorgang starten.

Zur Standardansicht zurückkehren.

REST-API

FLOWWER verfügt über ein umfangreiches REST-API, was den Datenaustausch direkt auf Systemebene ermöglicht.

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 / Belegen) 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.

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.

1 - API-Benutzer

FLOWWER sieht für Zugriffe auf die REST-API die Verwendung eines API-Benutzers vor.
Der API-Benutzer stellt automatisch einen API-Key zur Verfügung.

Vorteile

Sicherheits- und Audit-Logs

Da API-Benutzer separate Identitäten darstellen, kann ihre Nutzung in Protokollen leicht nachverfolgt und überwacht werden.
Dies erleichtert die Sicherheitsüberwachung und die Erkennung von Anomalien.

Organisation

Bewährte Praxis ist es, für jeden API-Zugreifenden (FLOWWER-Agent, FTP, InvoiceFetcher, etc.) einen eigenen API-Benutzer zu erstellen.

Langfristige API-Keys

Die API-Benutzer verwenden vom System vergebene API-Keys.
Diese sind dauerhaft gültig und somit für fortlaufende oder wiederkehrende Aufgaben ideal.

Eingeschränkte Berechtigungen

Das Konto kann so konfiguriert werden, dass es nur die für die jeweiligen API-Operationen erforderlichen Berechtigungen erhält.

Keine GUI-Abhängigkeit

API-Benutzer dürfen sich nicht an der FLOWWER-Benutzeroberfläche anmelden.
So ist sichergestellt, dass Integrationen nicht durch UI-Updates unterbrochen werden.

Minimierung menschlicher Interaktion

Da keine Benutzeroberfläche (UI) verwendet wird, gibt es weniger Möglichkeiten für Fehler oder unbefugten Zugriff durch menschliche Benutzer.

Vereinfachung:

Dar vergebene API-Key identifiziert den zugehörigen API-Benutzer eindeutig und ist in der FLOWWER-Benutzerverwaltung sichtbar.

Einrichtung

Zur Einrichtung: API-Benutzer

2 - Beispiele

Hochladen eines neuen Dokuments

Sende einen ‘POST’-Request an https://Ihre-FLOWWER-Kontokennung.flowwer.de/api/v1/upload Authentifizierung / Sicherheit

3 - Sicherheit

Die allermeisten Endpoints der FLOWWER-API finden im Kontext eines FLOWWER-Benutzers statt.
Hierfür ist zur Authentifizierung ein API-Key im HTTP-Header ("X-FLOWWER-ApiKey") des REST-Calls zu hinterlegen.

Einen API-Key können Sie über die Benutzeroberfläche im Bereich API-Benutzer der Benutzerverwaltung erstellen.