API-Adapter

Mit den API-Adaptern von STOAR bindest du bestehende Tools, ERPs und Integrationen an, ohne neuen Client-Code zu schreiben. Diese Seite erklärt, wie die Adapter funktionieren, wie du dich authentifizierst und wie du die Adapter im Adminbereich verwaltest.

Überblick #

STOAR stellt dieselben Produkt-, Bestell- und Kundendaten über vier protokollkompatible REST-API-Adapter bereit. Jeder Adapter zeigt eine vertraute API-Form, sodass deine bestehenden Client-Bibliotheken mit STOAR sprechen können, als wäre es die Plattform, für die sie gebaut wurden — ohne Codeänderungen.

Verfügbare Adapter #

Endpunktreferenzen und Details zu Anfragen und Antworten findest du in der jeweiligen Adapter-Dokumentation: Magento · Shopify · WooCommerce · BigCommerce.

Authentifizierung #

Alle vier Adapter verwenden persönliche Zugriffstokens von Sanctum. Um eine Anfrage zu authentifizieren, sende dein Token als Bearer-Token im Authorization-Header:

Authorization: Bearer <your-token>

Tokens werden unter Admin → REST API → API Tokens erstellt und verwaltet. Beim Erstellen weist du einem Token einen Satz von Abilities zu, der genau festlegt, auf welche Endpunkte es zugreifen darf — zum Beispiel products:read oder orders:write. Tokens lassen sich jederzeit widerrufen und optional mit einer Lebensdauer (TTL) versehen, sodass sie automatisch ablaufen.

Rate Limiting #

Standardmäßig gelten zwei Rate Limits:

• Authentifizierte Anfragen (tokenbasiert): 60 Anfragen pro Minute
• Öffentliche Anfragen (IP-basiert): 10 Anfragen pro Minute

Beide Limits sind konfigurierbar. Unter Admin → Einstellungen → API-Einstellungen passt du die Obergrenzen pro Minute an oder schaltest das Rate Limiting vollständig ein und aus.

Wird ein Limit überschritten, antwortet die API mit 429 Too Many Requests. Der Retry-After-Header gibt an, wie viele Sekunden du bis zum nächsten Versuch warten solltest.

Gemeinsame Datenschicht #

Alle vier Adapter lesen dieselben zugrunde liegenden Produkt-, Bestell- und Kundendaten. Jeder Adapter ist nur dafür zuständig, diese Daten in sein natives Antwortformat zu überführen — es gibt keine doppelten Datensätze und keine Synchronisation zu verwalten. Ein Produkt, das du im Adminbereich aktualisierst, ist sofort über jeden Adapter sichtbar.

Store Views #

Wenn du mehr als eine Storefront betreibst, berücksichtigen die Adapter deine Store Views. Die aktive View wird über die Domain aufgelöst, unter der die Anfrage eingeht: Eine Anfrage an die eigene Domain einer Store View liefert den Katalog dieser View — dasselbe Scoping, das auch die Storefront anwendet.

Eine Anfrage, die zu keiner Store-View-Domain passt, fällt auf deine Standard-Store-View zurück, die den vollständigen Katalog abdeckt. Integrationen, für die Store Views keine Rolle spielen, benötigen daher keine Anpassungen.

Die API verwalten #

Unter Admin → REST API verwaltest du deine API-Konfiguration:

• Adapter — die registrierten Adapter und ihre URL-Präfixe einsehen.
• API Tokens — neue Tokens erzeugen, Abilities zuweisen, eine TTL setzen und nicht mehr benötigte Tokens widerrufen.
• Einstellungen — Rate Limiting ein- oder ausschalten und die Obergrenzen pro Minute für authentifizierte und öffentliche Anfragen konfigurieren.