Shippo-Stecker

Integration mit der API von Shippo

Einführung

Shippo ist eine API und Web-App für den Versand mit mehreren Anbietern, darunter USPS, DHL, FedEx und viele andere. Kunden können Versandtarife abrufen, Etiketten drucken, internationale Dokumente automatisieren, Sendungen verfolgen und Rücksendungen erleichtern.

Zweck

Diese Integration zeigt, wie man die HTTP-Connector-Funktionen von Tulip für die Integration mit der API von Shippo nutzen kann, um die Erstellung von Sendungen zu automatisieren, eine Vielzahl von Tarifen von einer Reihe von Transporteuren zu erhalten, den besten Tarif auszuwählen und schließlich ein Versandetikett zu erstellen und zu drucken, zusammen mit der Option, die Sendungen zu verfolgen. All dies kann von Ihrer Tulip-Anwendung aus erfolgen. Abhängig von den verschiedenen Anwendungsfällen kann die Integration mit Tulip genutzt werden, um die Kontrolle über die eigene Supply-Chain zu behalten und eine Echtzeit-Transparenz beim Versand von Paketen zu erhalten.

API-Dokument

Shippo API-Dokumentation

Vorraussetzungen

Erstellen Sie ein Konto auf der Shippo-Website und generieren Sie API-Tokens, die als Autorisierungs-Header bei allen Aufrufen der Shippo-API verwendet werden. Shippo lässt Sie ein Test- und ein Live-Token generieren. Das Test-Token kann genutzt werden, um HTTP-Aufrufe mit der API zu testen und Ihre Tulip-Anwendung zu entwerfen. Sobald die Anwendung fertig ist, können die Token ausgetauscht werden und die Anwendungen können in der Produktion eingesetzt werden, um Versandetiketten und Transaktionen in Echtzeit zu erzeugen.

Details zur Tulip-Verbindung

Der HTTP-Connector von Tulip muss mit den folgenden Details konfiguriert werden, um eine Verbindung mit Shippo herzustellen.

1. Läuft auf: Cloud Connector Host
2. Rechner: api.goshippo.com
3. Anschluss:443
4. TLS:Ja
5. Shippo Tokens als Authorization Header können über die Connector Function übergeben werden

Connector Funktion

Sendung erstellen

Zweck

1. Diese Konnektorfunktion erstellt eine neue Sendung durch einen POST-Aufruf an die API von Shippo, wobei die Absender-, Empfänger- und Paketdaten Teil des Anforderungskörpers sind.
2. Nach erfolgreicher Erstellung gibt Shippo ein JSON-Objekt zurück, das den Status der erstellten Sendung sowie eine Auswahl an Tarifen von verschiedenen Anbietern enthält, die der Benutzer nutzen kann, um eine Transaktion zu initiieren. Die Benutzer können den richtigen Tarif auswählen und die Tarif-IDs in Tulip-Variablen speichern, die dynamisch zur Erstellung der Transaktion übergeben werden, um das Versandetikett in der entsprechenden Konnektorfunktion zu erzeugen.

Endpunkt

1. HTTP POST-Aufruf an den Endpunkt: https://api.goshippo.com:443/shipments/

Autorisierungs-Kopfzeile

Um sich mit der API von Shippo zu authentifizieren, muss das HTTP-Token von Shippo im Request Header übergeben werden. Das folgende Format lautet

Berechtigung : ShippoToken ($ShippoToken$)

Erforderliche Eingabe

Im Folgenden sind die Eingabeparameter aufgeführt, die im Request Body übergeben werden, wobei JSON der Inhaltstyp ist.

1. Name des Absenders, Straße, Ort, Bundesland, Postleitzahl, Land.
2. Name des Empfängers, Straße, Ort, Bundesland, Postleitzahl, Land
3. Abmessungen des Pakets - Länge, Breite, Breite und Gewicht

Erforderlicher Output-Extraktor

Für das erstellte Sendungsobjekt werden viele Informationen zurückgegeben, die wichtigsten zu extrahierenden Felder sind jedoch im Folgenden aufgeführt

1. Status: Zeigt an, ob die Sendung erfolgreich erstellt wurde
2. Sendungs-ID: Kann referenziert werden, um die Details der erstellten Sendung zu erhalten.
3. Tarif-Optionen: Array von Objekten, die verschiedene Optionen des von verschiedenen Anbietern angebotenen Tarifs angeben. Die Tarif-ID ist der wichtigste Schlüssel unter anderen, der extrahiert werden muss, um die eigentliche Transaktion für diese Sendung zu erstellen.

Transaktion erstellen

Zweck

1. Diese Konnektorfunktion erstellt die Transaktion nach der Auswahl des Lieferanten und des endgültigen Tarifs aus den verschiedenen Optionen, die bei der Erstellung einer neuen Sendung in der vorherigen Konnektorfunktion zurückgegeben wurden.
2. Eine erfolgreiche Transaktion wird durch einen POST-HTTP-Aufruf an den Endpunkt von Shippo unter Übergabe der mit dem gewählten Tarif verbundenen ID erstellt. Bei einem erfolgreichen Aufruf gibt Shippo ein JSON-Objekt zurück, das neben anderen Informationen den Status der Transaktion, die Tracking-ID, das Versandetikett und die Tracking-URL enthält. Das zurückgegebene Versandetikett kann direkt aus der Tulip App selbst gedruckt werden.

Endpunkt

1. HTTP POST-Aufruf an den Endpunkt: https://api.goshippo.com:443/transactions/

Autorisierungs-Kopfzeile

Um sich bei der API von Shippo zu authentifizieren, muss das HTTP-Token von Shippo im Anfrage-Header übergeben werden. Das folgende Format lautet

Berechtigung : ShippoToken ($ShippoToken$)

Erforderliche Eingabe

Im Folgenden sind die Eingabeparameter aufgeführt, die im Request Body übergeben werden, wobei JSON der Inhaltstyp ist.

1. Tarif-ID: Übergabe der ID des gewählten Tarifs, um eine erfolgreiche Transaktion zu erstellen.

Erforderlicher Output-Extraktor

Für das erstellte Shipment-Objekt werden viele Informationen zurückgegeben, die wichtigsten zu extrahierenden Felder sind jedoch im Folgenden aufgeführt

1. Status: Zeigt an, ob die Transaktion erfolgreich erstellt wurde
2. Transaktions-ID: Kann referenziert werden, um die Details der ausgeführten Transaktion zu erhalten.
3. Verfolgungsnummer: Zur Verfolgung der Sendung
4. Verfolgungs-URL: Die URL der Verfolgungsseite des gewählten Anbieters
5. Etikett-URL: Versandetikett, das in die Tulip-Anwendung zum Drucken eingebettet werden kann