Auf dieser Seite
Bevor Sie beginnen
Sie brauchen Zugang zur Open API, bevor ein Aufruf funktioniert: einen Client, den e-tailize freigegeben hat, sowie den Schlüssel und das Secret, die dazu gehören.
Version 1 der API liegt unter https://app.e-tailize.eu/public/api/v1 und umfasst 17
Endpunkte in drei Bereichen: Auth, Connections und Products. Die vollständige Liste, mit den
Feldern jedes Aufrufs, steht auf der Swagger Seite unter
https://app.e-tailize.eu/swagger/index.html.
Die API spricht nur JSON und gibt Ihnen einen Fehler als application/problem+json zurück.
Schritte
- Wählen Sie den Bereich, zu dem Ihr Aufruf gehört. Auth beantragt Zugang und erstellt, prüft und widerruft einen Schlüssel. Connections enthält den Katalog dessen, was Sie verbinden können, Ihre Verbindungen, Bestellungen, Sendungen und Weiterleitungsziele. Products enthält Ihre Produkte und deren Bestand.
- Setzen Sie die Header mit Zugangsdaten für diesen Bereich:
X-Api-ClientIdbei Auth undX-Api-KeyplusX-Api-Secretbei Connections und Products, wo beide Pflicht sind. Die erste Zugangsanfrage ist die Ausnahme, sie hat gar keinen Header. - Senden Sie bei jedem Aufruf
Accept: */*mit. Ein Client, der nurapplication/jsonakzeptiert, erhält ein 406 zurück statt der Fehlermeldung, die er lesen muss. - Rufen Sie
GET /Connections/definitionsauf, bevor Sie eine Verbindung anlegen. Der Aufruf liefert die Felder, die jeder Marktplatz verlangt, und bei den Namen inconnectionFieldszählt die Groß- und Kleinschreibung, übernehmen Sie sie also exakt. - Ordnen Sie Ihre eigenen SKUs mit
GET /Productsden Produkt IDs von e-tailize zu. Die Antwort ist ein Seitenobjekt, Sie blättern also durch das Ergebnis. - Aktualisieren Sie einen Bestand mit
PUT /Products/{id}/stockund einem Body, der den neuen Bestand enthält, zum Beispiel 25 Stück. Lesen Sie in der Antwortsucceeded, denndataist immer false, auch bei einem erfolgreichen Aufruf. - Halten Sie jede Route innerhalb ihres eigenen Budgets: Auth und Connections 10 Anfragen pro
60 Sekunden,
GET /Products30 pro 60 Sekunden,PUT /Products/{id}/stock25 pro 10 Sekunden. Gezählt wird pro Route, pro IP Adresse und pro Schlüssel, und der Zähler läuft nicht nach und nach leer: Jeder Aufruf startet die Uhr dieses Zeitraums neu. Der HeaderRetry-Aftergibt an, wie lange dieser Zeitraum noch läuft. - Warten Sie den ganzen Zeitraum ab, wenn ein Aufruf mit 429 antwortet, mit dem Titel "Too
many requests." und unter
errors.generalder Meldung "Rate limit exceeded. Try again in 60 seconds.", wobei die Zahl dem Zeitraum dieser Route entspricht. Warten Sie die Sekunden, die der HeaderRetry-Afternennt, eine reine Sekundenzahl und der einzige Header, den der Limiter hinzufügt. Ein früherer neuer Versuch startet die Uhr nur neu.
Wie es weitergeht
Was Sie senden, sind normale Plattformdaten. Eine Verbindung, die Sie per POST anlegen,
erscheint wie jede andere auf der Seite "API connections",
und eine Bestandsaktualisierung folgt den Weiterleitungsregeln dieser Verbindung, den Regeln,
die Sie mit GET /Connections/mutation-propagation-targets auslesen.
Diese Regeln bestimmen die Richtung: Der Bestand geht von Ihnen zum Marktplatz, Bestellungen
kommen vom Marktplatz zu Ihnen, und die Sendungsverfolgung geht pro Verbindung hinaus, oder
pro Sendung mit POST /Connections/{id}/shipment.
Häufige Probleme
Ein Aufruf ohne den Schlüsselheader antwortet mit 400, nicht mit 401. Der Titel lautet "One
or more validation errors occurred." und errors.general sagt, was nicht stimmt: "X-Api-Key
header is missing." bei einem fehlenden Schlüssel, "X-Api-Secret header is missing." bei
einem leeren Secret und "Invalid X-Api-Key header value." bei einem Schlüssel, der keine GUID
ist. Die Meldung steht immer unter errors.general, nie in einem Feld detail.
Ein 401 bedeutet, dass der Header vorhanden und korrekt aufgebaut ist, aber nicht akzeptiert wird: Der Client ist noch nicht freigegeben, der Schlüssel oder das Secret ist falsch, oder der Schlüssel ist abgelaufen.
Eine Verbindungs ID, die nicht Ihnen gehört, antwortet mit 404, genau wie eine ID, die nicht existiert, die Antwort verrät also nie, welche IDs es gibt.
Ein POST /Connections, der die Validierung nicht besteht, zum Beispiel wegen eines doppelten
Verbindungsnamens, kann als 500 zurückkommen. Lesen Sie die Meldung in diesem Body, sie nennt
die eigentliche Ursache.
Häufig gestellte Fragen
Wo finde ich jeden Endpunkt und seine Felder?
Auf der Swagger Seite unter https://app.e-tailize.eu/swagger/index.html, mit den
Parametern und den Antworten aller 17 Endpunkte. Prüfen Sie eine echte Antwort, bevor Sie
sich auf die Form eines Fehlerbodys verlassen, damit Ihr Client dem tatsächlichen Verhalten
folgt.
Kann ich zwei API Keys gleichzeitig haben?
Nein. Das Erstellen lehnt einen zweiten aktiven Schlüssel für denselben Nutzer ab. Rotieren heißt, zuerst den vorhandenen Schlüssel zu widerrufen und danach einen neuen zu erstellen.
Ist eine Bestell ID eindeutig?
Nur innerhalb eines Marktplatzes. Zwei Marktplätze können Ihnen dieselbe Bestell ID geben, verknüpfen Sie Ihre eigenen Datensätze also mit der Verbindungsdefinition zusammen mit der Bestell ID, nie mit der ID allein.
Ähnliche Artikel
War das hilfreich?