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

API

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

1: Authentifizierung
2: Beispiele
3: Dienstkonto für API-Zugriffe

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. 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 Marktplatz-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 - Authentifizierung

Die Authentifizierung findet über ein Token ("X-FLOWWER-ApiKey") im HTTP-Header des REST-Calls statt.

Ein Token können Sie über ein Dienstkonto für API-Zugriffe (bevorzugte Methode) erstellen.

2 - Beispiele

Hochladen eines neuen Dokuments

Sende einen ‘POST’-Request an https://Ihre-FLOWWER-Kontokennung.flowwer.de/api/v1/upload Authentifizierung / Sicherheit Die Authentifizierung findet über ein Token ("X-FLOWWER-ApiKey") im HTTP-Header des REST-Calls statt.

Ein Token können Sie über ein Dienstkonto für API-Zugriffe (bevorzugte Methode) erstellen.

3 - Dienstkonto für API-Zugriffe

FLOWWER bietet die Möglichkeit, für Zugriffe auf die REST-API ein Dienstkonto (auch bekannt als ‘API-only Konto’) zu verwenden. Ein Dienstkonto für Zugriffe auf die FLOWWER-API zu nutzen bringt mehrere Vorteile.

Info

Das Zugriffstoken ist fest mit dem Dienstkonto verbunden.
Daher wird kein zusätzlicher Benutzername benötigt.

Vorteile

Sicherheits- und Audit-Logs

Da Dienstkonten 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.exe, FTP, InvoiceFetcher, etc.) einen eigenen API-Benutzer zu erstellen.

Langfristige Zugriffstoken

Die Dienstkonten für API-Zugriffe verwenden vom System vergebene Zugangstoken.
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-Dienstkonten 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:

Das vergebene API-Token identifiziert das zugehörige Dienstkonto eindeutig und ist in der FLOWWER-Benutzerverwaltung sichtbar.

Einrichtung

Zur Einrichtung: Dienstkonto für API-Zugriffe