API-Dokumentation
Diese Seite ist ein Nachschlagewerk für Entwicklerinnen und Entwickler, die eine eigene Anwendung an Ihren Shop anbinden möchten. Sie gibt einen Überblick über die verfügbaren Themenbereiche, die Anmeldeverfahren und die Webhook-Ereignisse. Die Inhalte dieser Seite sind redaktionell gepflegt, nicht automatisch aus der laufenden Schnittstelle erzeugt. Die technisch verbindliche Referenz ist die interaktive Dokumentation der Schnittstelle selbst (siehe unten).
Was kann ich hier tun?
- Sich einen Überblick über die Endpunkte nach Themenbereichen verschaffen
- Die grundsätzlichen Anmeldeverfahren nachlesen (OAuth beziehungsweise Bearer-Token)
- Die Liste der Webhook-Ereignisse als Ausgangspunkt für eine Anbindung nutzen
- Codebeispiele in verschiedenen Programmiersprachen ansehen
- Verfügbare Software-Entwicklungspakete (SDKs) einsehen
Zum Ansehen dieser Seite ist keine besondere Berechtigung nötig; jede angemeldete Person mit Zugang zur Verwaltung kann sie öffnen. Die Seite ruft selbst keine Daten Ihres Shops ab.
Die verbindliche Referenz
Neben dieser Übersichtsseite liefert die Schnittstelle selbst eine interaktive Dokumentation, die direkt aus dem laufenden Programmcode erzeugt wird. Sie ist immer aktuell und deshalb die Quelle, nach der Sie eine Anbindung bauen sollten:
| Was | Pfad auf der API-Adresse Ihres Shops |
|---|---|
| Alle Endpunkte | /api/docs |
| Nur Storefront (kundenseitig) | /api/docs/storefront |
| Nur Verwaltung (Admin) | /api/docs/admin |
| Maschinenlesbare Beschreibung (OpenAPI) | /api/v1/openapi.json |
Alle Endpunkte der Shop-Ebene liegen unter dem Präfix /api/v1. Ein Aufruf ohne dieses Präfix beantwortet der Server mit 404, was leicht wie ein Ausfall aussieht, aber keiner ist.
Schritt für Schritt
- Themengebiet finden: Bleiben Sie im Reiter „Endpunkte" und wählen Sie links eine Themengruppe (zum Beispiel Produkte, Bestellungen), um die zugehörigen Endpunkte zu sehen.
- Anmeldeverfahren nachlesen: Der Reiter „Authentifizierung" erklärt das Grundprinzip. Die eigentlichen Zugangsdaten legen Sie unter OAuth-Clients an.
- Webhooks nachschlagen: Der Reiter „Webhooks" listet die Ereignisse und zeigt den Aufbau der Signatur. Eingerichtet werden Webhooks unter Webhooks (Shop).
- Codebeispiel-Sprache wechseln: Wählen Sie oben rechts eine Programmiersprache. Die Auswahlliste hat ein Suchfeld, tippen Sie den Namen der Sprache statt zu scrollen.
- Gegen die echte Schnittstelle arbeiten: Öffnen Sie
/api/docsauf der API-Adresse Ihres Shops. Dort können Sie Anfragen mit Ihren eigenen Zugangsdaten tatsächlich absetzen.
/shop/api-docs- Header
- Authorization: Bearer <your-api-key>
/shop/api-docsFelder erklärt
| Feld | Bedeutung | Hinweise/Auswirkung |
|---|---|---|
| Basis-Adresse | Grundadresse, die den Endpunkten vorangestellt wird | Wird aus dem Hostnamen Ihrer Verwaltung abgeleitet und zeigt Ihre tatsächliche API-Adresse. Weicht sie ab, prüfen Sie Domains |
| Themengruppe | Fachliche Gruppierung der Endpunkte | Dient der Navigation |
| Endpunkt | Einzelner Zugriffspunkt mit Methode, Pfad und Beispieldaten | Redaktionell gepflegte Liste, siehe Hinweis oben |
| Codebeispiel-Sprache | Programmiersprache der angezeigten Beispiele | Auswahl über das Feld oben rechts, mit Suchfeld |
| Sandbox | Verweis auf die echte interaktive Referenz | Baut selbst keine Anfrage, siehe unten |
Der Reiter „Sandbox"
Der Reiter „Sandbox" führte bis 2026-08-31 eine eigene Anfrage-Vorführung: eine Schaltfläche „Senden", die nach kurzer Wartezeit eine fest hinterlegte Beispielantwort mit den Demo-Produkten prod_demo1/prod_demo2 zeigte, ganz gleich was in der Adresszeile stand - inklusive einer Erfolgsmeldung, obwohl nie eine Verbindung aufgebaut wurde. Das ist entfernt worden, weil eine Erfolgsmeldung ohne tatsächlichen Versand in keinem Fall vertretbar ist.
Der Reiter besteht jetzt aus einem einzigen Verweis: einer Schaltfläche „Interaktive Referenz öffnen", die /api/docs auf der echten API-Adresse Ihres Shops in einem neuen Tab öffnet. Dort setzen Sie mit Ihren eigenen Zugangsdaten tatsächliche Anfragen ab - inklusive echter Fehlermeldungen, wenn Adresse, Token oder Rechte nicht stimmen.
Begrenzung der Anfragehäufigkeit
Die Schnittstelle begrenzt, wie viele Anfragen pro Minute angenommen werden. Tatsächlich wirksam sind derzeit:
| Bereich | Grenze |
|---|---|
| Storefront-Endpunkte (kundenseitig) | 100 Anfragen pro Minute |
| Verwaltungs-Endpunkte (Admin) | 600 Anfragen pro Minute |
| Anmelde-Endpunkte | 60 Anfragen pro Minute |
Wird die Grenze überschritten, antwortet der Server mit dem Status 429. Bauen Sie in Ihrer Anwendung eine Wiederholung mit wachsendem Abstand ein, statt sofort erneut anzufragen.
Häufige Fragen
Wer sollte diese Seite nutzen?
In erster Linie Entwicklerinnen und Entwickler oder technische Dienstleister, die eine eigene Anwendung an Ihren Shop anbinden. Für die Anbindung selbst ist die interaktive Dokumentation unter /api/docs die bessere Grundlage, weil sie unmittelbar aus dem laufenden Programmcode stammt.
Kann ich hier echte Daten meines Shops abfragen?
Nicht auf dieser Seite selbst - sie ist Nachschlagewerk, keine Konsole. Der Reiter „Sandbox" verweist Sie aber direkt auf /api/docs, wo Sie mit Ihren eigenen Zugangsdaten echte Anfragen absetzen.
Wie erhalte ich Zugangsdaten für die Schnittstelle?
Für Anwendungen von Drittanbietern legen Sie unter OAuth-Clients einen Zugang an. Das Geheimnis wird genau einmal angezeigt, danach nicht mehr; notieren Sie es sofort.
Warum weicht die hier gezeigte Basis-Adresse von meiner ab?
Die Adresse wird aus dem Hostnamen Ihrer Verwaltung abgeleitet und sollte mit Ihrer tatsächlichen API-Adresse übereinstimmen. Weicht sie dennoch ab, prüfen Sie Domains.
Warum bekomme ich auf jeden Aufruf eine 404?
Sehr wahrscheinlich fehlt das Präfix /api/v1. Ein Aufruf von /auth/login läuft ins Leere, richtig ist /api/v1/auth/login.