Zum Hauptinhalt springen

API-Kommunikation

Konzept

Die Kommunikation zwischen Diensten soll über versionierte, authentifizierte und klar verantwortete Schnittstellen erfolgen. Ein Dienst erhält nur den Zugriff, den seine Aufgabe benötigt.

Grundmuster​

Das Diagramm zeigt Abhängigkeiten im Zielbild, keine aktuell erreichbaren Endpunkte.

Synchrone und ereignisbasierte Abläufe​

Direkte Anfragen eignen sich für Vorgänge, die eine unmittelbare Antwort benötigen. Ereignisse eignen sich für entkoppelte Folgeaktionen wie Benachrichtigungen. Ein möglicher Event-Bus ist noch nicht als konkrete Implementierung festgelegt.

Sicherheitskontext​

Produkt-APIs sollen einen begrenzten, prüfbaren Sicherheitskontext nach freigegebenen Regeln auswerten können. Die fachliche Berechtigung an einer Ressource wird weiterhin dort durchgesetzt, wo diese Ressource geschützt wird. Das konkrete Format ist noch nicht festgelegt.

Nachvollziehbarkeit​

Kommunikationsvorgänge benötigen eindeutige Zuständigkeiten, begrenzte Wiederholungen, kontrollierte Fehlerbehandlung und eine angemessene Protokollierung. Vertrauliche Inhalte gehören nicht in öffentliche Protokolle oder diese Dokumentation.