API - Übersicht

Die Lengow API ermöglicht den Datenaustausch zwischen Lengow und Ihrem Backoffice (kann Ihr eigenes Backoffice oder eine Software wie Prestashop, Magento usw. sein).

Unterschiedliche "Endpunkte" bevölkern die API:

  • /orders/

Rufen Sie alle Ihre Bestellungen von jedem Marktplatz ab, den Sie in Lengow eingerichtet haben

  • /orders/actions/
Verwalten und aktualisieren Sie Ihre Bestellungen (Bestellung annehmen, Versand bestätigen, stornieren...) entsprechend der Marktplatzliste der akzeptablen Bestellstatus.
  • /marketplaces/
Sehen Sie alle gültigen Bestellstatus der Marktplätze und gültige Aktionen, die Sie bei einer Bestellung durchführen können.
Keine Aktion hier möglich.

Finden Sie unten unsere Konventionen. Diese Konventionen sind geschrieben, um Ihnen beim Erstellen Ihrer API-Anfragen und -Aktionen zu helfen.

Ausführen von Anfragen / HTTP-Antwortcodes

Die Lengow API liefert HTTP-Antwortcodes für jede Anfrage, die mit dem Körper und der Aktion übereinstimmen, die der Benutzer versucht hat.

Hier sind die am häufigsten verwendeten Antwortcodes der Lengow API:

  • Code 200: OK = Der HTTP 200 OK Erfolgsstatus Antwortcode zeigt an, dass die Anfrage erfolgreich war.
  • Code 201: Erstellt = Die Anfrage wurde erfüllt, eine neue Ressource wurde erstellt.
  • Code 202: Akzeptiert = Die Anfrage wurde zur Verarbeitung akzeptiert, aber die Verarbeitung wurde noch nicht abgeschlossen.
  • Code 400: Schlechte Anfrage = Der Server kann oder will die Anfrage aufgrund eines offensichtlichen Client-Fehlers (Validierung, falsche Ressourcen-URL, etc.) nicht verarbeiten.
  • Code 401: Zugriff nicht gewährt = Wird verwendet, wenn eine Authentifizierung erforderlich ist und fehlgeschlagen ist oder noch nicht bereitgestellt wurde.
  • Code 403: Verboten = Die Anfrage war gültig, aber der Server verweigert die Aktion. Keine Berechtigung zur Nutzung der Ressource.
  • Code 404: Nicht gefunden = Die angeforderte Ressource konnte nicht gefunden werden, könnte aber in der Zukunft verfügbar sein.
  • Code 429: Anfragelimit erreicht = Es wurden zu viele Anfragen in zu kurzer Zeit gemacht.
  • Code 530: Logischer Fehler = Die Anfrage ist wahrscheinlich aufgrund schlechter Eingabeparameter (Katalog, der nicht existiert, ungültige Suchregeln...) fehlgeschlagen. Siehe begleitende Nachricht für weitere Informationen.
  • Code 540: Technischer Fehler = Die Anfrage ist aufgrund eines internen Fehlers fehlgeschlagen. Siehe begleitende Nachricht für weitere Informationen.
Für weitere Informationen siehe die Liste der HTTP-Code-Status

Content-Type und Accept Headers

Der "Accept"-Header gibt das Format der Anfrage an, das Sie erhalten möchten.

Im Gegensatz dazu definiert der "Content-Type"-Header das Format, das der Anrufer an die API sendet. Abhängig vom Endpunkt unterstützt die Lengow API eine Reihe von verschiedenen Nachrichtenformaten.

Wenn Sie das zurückgegebene Datenformat ändern möchten, können Sie den Accept Header setzen. Der Server wird Ihnen im angegebenen Format antworten und den Content-Type Header ändern.

  • Standardmäßig ist das Format “application/json”.

Um alle akzeptierten Formate zu erhalten, können Sie die OPTIONS Methode wie unten verwenden:

/orders/

gehen Sie zu OPTIONS > headers

Schlüssel: Accept: application/json"

Ändern Sie den Schlüssel mit dem angeforderten Format.

7444a46d-970a-4b42-86de-e0f774bbe052.png

Bildquelle: Postman

Datum- und Zeitfelder

Die Datums- und Zeitfelder werden im ISO-8601-Standard auf Sekunden gekürzt mit einem Offset von UTC dargestellt.

Das für die Lengow API verwendete Datums- und Zeitformat ist unten aufgeführt (unser Beispiel ist in JSON und kann in anderen Programmiersprachen variieren. Bitte beziehen Sie sich für weitere Informationen auf Ihre Sprachdokumentation).

Format: yyyy-MM-dd'T'HH:mm:ssXXX

Beispiel für Datums-/Zeitausgabe:

{
"marketplace_order_date": "2019-03-22T17:54:34.369000Z"
}

Preise, Währungen und Länder

  • Alle Geldbeträge wie Preise werden als Dezimalzahl angegeben.

Beispiel: 5.50

  • Alle Währungen werden mit drei Zeichen angegeben, gemäß der ISO 4217 Konvention.

Beispiel : EUR

  • Je nach Ressource werden Länder mit zwei oder drei Zeichen angegeben, gemäß der ISO 3166-2 Konvention.

Beispiel: FR

Ausführen von Anfragen / HTTP-Methoden

Unterstützte HTTP-Methoden:

  • GET
Daten abrufen von der API.
Beispiel: Findet die Liste der Bestellungen mit dem Lengow-Status "Warten auf Versand"
  • POST
neue Daten hinzufügen. Die POST-Methode sendet Daten an den Server.
Beispiel: Erstelle
Erstellt eine neue Sendungsaktion basierend auf den Informationen im Anforderungskörper, gibt einen Antwortkörper zurück, der auf die erstellte Sendung nach der Erstellung verweist
  • PUT: vorhandene Daten ersetzen
  • PATCH: einige vorhandene Datenfelder aktualisieren
  • DELETE: vorhandene Daten löschen
0c35aff0-3f8e-410d-a64c-eb217de90202.jpg

Bildquelle: Postman

Automatische HTTPS-Umleitung

Abschaltung von HTTP-Diensten zugunsten von HTTPS
Als Teil der kontinuierlichen Verbesserung der Sicherheit innerhalb unserer Plattform und um die Sicherheit Ihrer Daten zu gewährleisten, wird die automatische Umleitung von HTTP-Flows zum HTTPS-Protokoll nicht mehr verfügbar sein ab dem 1. September 2022.

Ohne Ihr Zutun werden Serviceausfälle auftreten, ohne dass unsere Support-Teams in der Lage sind, das Problem zu lösen.

Wie kann die Verfügbarkeit unserer Dienste aufrechterhalten werden?

Um die Verfügbarkeit unserer Dienste von Ihren Tools aus zu gewährleisten, empfehlen wir Ihnen, Ihre Einstellungen zu überprüfen und zu aktualisieren. 
Je nach Ihrer Organisation und Ihrem Handlungsspielraum kann es notwendig sein, dass Ihre technische Abteilung die Änderungen vornimmt.

Wo überprüfe ich diese Informationen?

Das hängt davon ab, wie Sie die Lengow-Plattform nutzen.

  • Wenn Sie Tools zur Überwachung Ihrer Bestellungen, zum Importieren von Katalogen oder anderen Informationen in ein ERP haben:

Überprüfen Sie die Einstellungen dieser Tools. Wenn die Einstellungen Ihres Tools eine URL http://api.lengow.io/... angeben, müssen Sie nur das "http" durch "https" ersetzen (https://api.lengow.io/...) und die Änderung speichern.

  • Wenn Sie Lengow Kurz-URLs auf einem oder mehreren Kanälen eingerichtet haben:

Um weiterhin Ihre Kataloge auf die Kanäle zu exportieren, überprüfen Sie die auf jedem von ihnen gespeicherten Einstellungen. Wenn die angegebene Einstellung das HTTP-Protokoll verwendet (http://feeds.lengow.io/3/...), ändern Sie die URL, um das HTTPS-Protokoll zu verwenden (https://feeds.lengow.io/3/...)

Nachdem Sie Ihre Änderungen bestätigt haben, können Sie überprüfen, ob der aktualisierte Dienst ordnungsgemäß funktioniert. 

Dieser Artikel wurde automatisch übersetzt. Bei Unsicherheiten bitten wir Sie, die Originalversionen auf Französisch oder Englisch zu konsultieren.

Beiträge in diesem Abschnitt

Unsere Supportzeiten:
Montag bis Freitag von 9:00 - 18.30 Uhr