Anmelden

nShift Help Center

Erste Schritte mit der DeliveryCheckout API

Avatar
Malene Tidemann
Aktualisiert

Delivery-checkout-label.png


Die DeliveryCheckout API ist ein Integrationsdienst für die Kommunikation zwischen Delivery Checkout und Ihrem Webshop.

 

Abschnitte in diesem Artikel:

Einführung

Die DeliveryCheckout API verwendet ein REST-API-Framework zur Kommunikation mit JSON als Datenträger und bietet eine Reihe von Funktionen.

Mit der DeliveryCheckout API können Sie:

  • Versandoptionen in Ihrem Webshop anzeigen.
  • Sendungen vorbereiten.
  • Agentenlisten hochladen.

Die REST-API-Endpunkte sind nur über HTTPS erreichbar und befinden sich unter api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

 

Bevor Sie beginnen, müssen Sie Ihre Developer ID kennen und einen API-Schlüssel erstellen.

Als Händler haben Sie Ihre Logistik möglicherweise an einen Drittanbieter für Logistikdienstleistungen (3PL) ausgelagert. Sie benötigen ein Konto, in dem Sie den Checkout konfigurieren, und der 3PL benötigt ein Konto zum Drucken der Sendungen. Der empfohlene Prozess in Delivery Checkout besteht darin, die Antwort von POST /delivery-checkouts/{deliveryCheckoutId} an Ihren 3PL zu senden. Dadurch wird die Sendung über das nShift Delivery-Konto des 3PL erstellt.

Alternativ kann der 3PL die Informationen zur vorbereiteten Sendung über GET /prepared-shipments/{prepareId} abrufen.

Wir empfehlen, für jede Checkout-Sitzung eine Fallback-Lösung vorzubereiten, falls Sie keine Antwort von unserer API erhalten, beispielsweise aufgrund von Wartungsarbeiten. So stellen Sie sicher, dass Ihren Kunden immer Versandoptionen angezeigt werden.



 

Delivery Checkout-Ablauf

checkout-flows.png

 

 

API-Schlüssel

Ein API-Schlüssel ist eine eindeutige Kennung, die zur Authentifizierung einer Anwendung oder eines Benutzers verwendet wird. API-Schlüssel können auf Konto- oder Profilebene verwendet werden.

Wenn die Profilverwaltung für Ihr Konto aktiviert ist, können Sie API-Schlüssel erstellen, die mit einem bestimmten Profil verknüpft sind. Dieser API-Schlüssel verwendet dann die Profilgruppe des ausgewählten Profils, um zu filtern, welche Informationen Sie über die API abrufen können und wohin diese gesendet werden.


 

Einen API-Schlüssel erstellen

  1. Melden Sie sich bei nShift Delivery an.
     
  2. Gehen Sie zu Maintenance > API keys.

    API-keys.png
     
  3. Klicken Sie auf New API key.
     
  4. Status sollte auf „Enabled“ gesetzt sein.
     
  5. Type sollte auf „Web Services (REST)“ gesetzt sein.
     
  6. Geben Sie im Feld Note an, wofür der API-Schlüssel verwendet wird. Da Sie mehrere API-Schlüssel erstellen können, wird empfohlen, das Feld Note zu verwenden.
     
  7. Geben Sie unter Valid IP addresses die IP-Adressen oder IP-Adressbereiche ein, von denen der API-Schlüssel verwendet werden darf.
     
  8. Das Feld Email wird derzeit nicht verwendet.
     
  9. Geben Sie Ihre Developer ID ein. Normalerweise ist die Developer ID Ihre Benutzer-ID des Kontos. Wenn Sie jedoch ein ERP-Anbieter, Webshop-Anbieter oder ein anderer Drittanbieter sind oder einen solchen nutzen, der Daten in das Konto überträgt, ist dies die Benutzer-ID des Kontos dieses Anbieters.
     
  10. Wählen Sie im Dropdown-Menü ein Profile aus, wenn der API-Schlüssel mit einem bestimmten Profil verknüpft werden soll.
     
  11. Klicken Sie auf Save. Das System generiert automatisch den Schlüssel, bestehend aus einer ID, einer Secret ID und einer kombinierten ID.
    Für die Authentifizierung gegenüber dem REST-API-Framework verwenden Sie die ID und die Secret ID.

    new-API-key.png

Verwenden Sie die Suchfunktion, um nach Ihren API-Schlüsseln zu suchen.

 

Verwandte Beiträge