Zum Inhalt

REST API

Plattformverwaltung und systemweite Funktionen.

Die Flowtig REST API bietet Zugriff auf Funktionen auf Plattformebene, die innerhalb des gesamten Flowtig-Ökosystems gemeinsam genutzt werden.

Im Gegensatz zur GraphQL API, die sich auf Geschäftsanwendungen und mandantenspezifische Daten konzentriert, ist die REST API hauptsächlich für Authentifizierung, Administration und infrastrukturelle Funktionen zuständig.

Plattform-API

REST-Endpunkte sind für systemweite Funktionen vorgesehen und nicht für anwendungsspezifische Geschäftslogik.

Wann sollte ich die REST API verwenden?

Verwenden Sie die REST API, wenn Sie mit der Flowtig-Plattform selbst und nicht mit einer einzelnen Anwendung interagieren möchten.

Typische Beispiele sind:

  • Authentifizierung
  • Organisationsverwaltung
  • Benutzerverwaltung
  • Abonnementverwaltung
  • Abrechnung
  • Plattformkonfiguration

Wenn Sie Funktionen innerhalb von Anwendungen wie Rechnungen, Kontakte oder Lager entwickeln, verwenden Sie stattdessen in der Regel die GraphQL API.

Typische Zuständigkeiten

Die REST API verwaltet plattformweite Ressourcen wie:

  • Organisationen
  • Benutzer
  • Teammitgliedschaften
  • Rollen
  • Berechtigungen
  • Abonnementtarife
  • Anwendungsbuchungen

Diese Ressourcen existieren unabhängig von einzelnen Geschäftsanwendungen.

Authentifizierung

REST-Endpunkte sind durch tokenbasierte Authentifizierung geschützt.

Jede Anfrage wird im Organisationskontext des authentifizierten Benutzers ausgewertet.

Bevor Zugriff gewährt wird, werden die plattformweiten Berechtigungen geprüft.

Weitere Informationen zum grundlegenden Sicherheitsmodell finden Sie in der Dokumentation zur Architektur.

API-Dokumentation

Die vollständige OpenAPI-Spezifikation mit Beschreibungen der Endpunkte, Anfragebeispielen und Antwortschemas steht über die interaktive API-Dokumentation zur Verfügung.

👉 https://api.flowtig.com/api/doc/swagger-ui/

Über die Swagger-Oberfläche können Sie:

  • Alle verfügbaren Endpunkte durchsuchen
  • Anfrage- und Antwortschemas untersuchen
  • Testanfragen ausführen
  • Authentifizierungsanforderungen nachvollziehen

Weiterführende Dokumentation

Je nachdem, was Sie entwickeln möchten, können auch die folgenden Dokumentationen hilfreich sein:

Benötigen Sie Hilfe?

Wenn Sie Fragen zur Integration mit der Flowtig-Plattform haben, kontaktieren Sie uns über die offizielle Supportseite:

👉 https://flowtig.com/contact