Zum Inhalt springen

API & Integration

buzzle Commerce Core ist von Grund auf als offene, integrierbare Plattform ausgelegt. Dieser Abschnitt richtet sich an Entwicklerinnen und Entwickler, die die Plattform anbinden oder auf ihr aufbauen möchten. Er gibt einen konzeptionellen Überblick – die konkreten Endpunkte und Felder stimmst du mit deinem Ansprechpartner bei bambit ab und liest sie aus der stets aktuellen Swagger-Oberfläche der jeweiligen Instanz.

Alle Zugriffe laufen über das API Gateway. Eine Client-Anwendung kennt nur diese eine Adresse; das Gateway leitet die Anfrage an das zuständige Modul weiter. Die Module sind unter ihrem jeweiligen Pfad-Präfix erreichbar, zum Beispiel:

  • /business – Firmen, Personen, Adressen, Rollen, Logins,
  • /catalog – Produktkatalog, Kategorien, Angebote, Kaufberechtigung,
  • /order – Warenkörbe, Checkout, Aufträge, Preiszeilen,
  • /search – Volltext- und semantische Suche, Filter, feldbasierte Abfragen,
  • /cdn – Auslieferung von Medien, Packshots und Downloads,
  • /databridge – Import, Export, Workflows, Registeranbindung,
  • /reporting – Kennzahlen und Auswertungen,
  • /customer – Mandanten, Nutzer, Standorte, Onboarding, Zugang,
  • /audit – Abfrage des Änderungsverlaufs.

Welche Module eine Instanz aktuell bereitstellt, lässt sich maschinenlesbar über den /modules-Endpunkt der Service Platform abfragen.

Die Funktionalität ist über REST-Endpunkte zugänglich, die einem einheitlichen Muster folgen. Daten werden als JSON ausgetauscht. Jedes Modul folgt denselben Konventionen, weil alle auf derselben Infrastrukturschicht aufsetzen – wer ein Modul kennt, findet sich in den anderen schnell zurecht.

Jedes Modul stellt eine Swagger-/OpenAPI-Oberfläche bereit, über die sich alle Endpunkte erkunden und direkt ausprobieren lassen – erreichbar unter /<modul>/swagger, das Schema unter /<modul>/swagger/v1/swagger.json. Dort sind Parameter, Request- und Response-Schemata sowie die Authentifizierung dokumentiert. Diese Oberfläche ist die verbindliche, stets aktuelle Referenz für die Integration.

Der Zugang ist standardkonform über Zitadel abgesichert:

  • Eine Anwendung meldet sich über OIDC/OAuth2 an und erhält ein Zugriffstoken.
  • Das API Gateway prüft dieses Token bei jeder Anfrage über Token-Introspection, bevor es sie weiterleitet.
  • Die Module werten Rollen-Claims aus dem Token aus, um Berechtigungen durchzusetzen.

Für System-zu-System-Zugriffe eignen sich Maschinenbenutzer und entsprechende OIDC-Clients, die über die ZitadelBridge eingerichtet werden.

Für die Anbindung an andere Systeme gibt es zwei komplementäre Wege:

  • Datenintegration über das DataBridge-Modul – Import, Export und die Anbindung externer Register, robust und wiederholbar im Hintergrund verarbeitet.
  • Ereignisintegration über den Nachrichtenbus – wer auf Vorgänge in der Plattform reagieren will, abonniert die passenden Ereignisse, statt zu pollen.

Einen Überblick über konkret angebundene Fremdsysteme – ERP, Zahlungsanbieter, Kassensysteme, EDI/Branchennetze, Register, Identity-Provider, Marketing, E-Learning und BI – gibt die Seite Integrationen.

Jeder Dienst und jedes Modul stellt einen Health-Check bereit (/healthcheck bzw. /<modul>/healthcheck). Zusammen mit strukturiertem Logging und den Info-Seiten der Plattform lässt sich der Zustand einer Integration jederzeit überprüfen.

Die Kombination aus einem einzigen gesicherten Eingang, selbstbeschreibenden Modul-APIs, standardkonformer Identität und zwei klaren Integrationswegen macht buzzle Commerce Core anschlussfähig – als Plattform, die sich sauber in eine bestehende Systemlandschaft einfügt. Wie sie betrieben und ausgerollt wird, beschreibt das Kapitel Installation & Betrieb.