REST-API

Zweck der API

Um Drittsoftware effizient an FLOWWER anbinden zu können, haben wir dem Systeme eine Programmierschnittstelle hinzugefügt. Programmierschnittstellen sind auch bekannt als API (Application Programming Interface).
Auf diese Weise kann Software ohne die grafische Benutzeroberfläche nutzen zu müssen, direkt mit dem FLOWWER-System Daten austauschen.

API-Format

Die FLOWWER-API folgt der OpenAPI-Specification – einem Standard zur Beschreibung REST-konformer Programmierschnittstellen. Damit wird die Nutzung API-Tools wie z.B. Postman oder verschiedener Client-Generatoren möglich.

Beschreibung der API

Jedes FLOWWER-Konto verfügt über eine eigene REST-API. Zur einfacheren Orientierung steht ‚Swagger UI‘ jedem FLOWWER-Konto unter folgendem URI zur Verfügung: https://Ihre-FLOWWER-Kontokennung.flowwer2.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.

Client-Erstellung

Unter Zuhilfenahme des Drittanbieterprogramms ‚OpenAPI-Generator‘ kann aus der OpenAPI-Spezifikation von FLOWWER ein passender Schnittstellen-Client erstellt werden.

Erstellung über die Kommandozeile

Die folgenden Schritte sind unter Verwendung von PowerShell beschrieben und lediglich als gedanklicher Einstieg in die Thematik zu verstehen. Die Ort zu passenden java.exe wird als Bestandteil der PATH-Umgebungsvariable vorausgesetzt.

Download des OpenAPI Generators (derzeit (2021-06-28) aktuelle Version ist 5.1.1):
PS > Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/5.1.1/openapi-generator-cli-5.1.1.jar

Erzeugen eines FLOWWER-ApiClients unter Verwendung des csharp-netcore Generators (-g csharp-netcore) mit Einschränkung auf die Download-API (–global-property apis=Download).
PS C:\temp> java -jar .\openapi-generator-cli.jar generate -g csharp-netcore -i https://200001.flowwer2.de/swagger/v1/swagger.json -o FLOWWER-API --global-property apis=Download

Erstellung mit dem Online-Generator

Zum aktuellen Zeitpunkt (2021-06-14) beherrscht der online Swagger Editor leider nicht die Erstellung von ‚csharp-netcore‘-Clients.

Den Swagger Online-Generator finden Sie unter folgendem URI: Swagger Editor (online)

Schlagworte: