API Dokumentation und Quick Start Guide

Thema: Alls was Du über die Integration Deines eigenen Webshops über unsere (RESTful) APIs wissen musst.

Zugehörige Links:

• Sendcloud API Referenz
• Sendcloud Entwickler Portal
• API Paketshopzustellung

Sendcloud bietet Funktionen und Tools, die E-Commerce-Unternehmen helfen, den Versand von Bestellungen zu automatisieren. Unsere vollständig skalierbaren Funktionen machen das Leben von Online-Händlern einfach, egal ob es sich um Einzelunternehmen, Start-Ups oder Großunternehmen mit tausenden Bestellungen im Monat handelt.

Sendcloud integrieren

Es gibt zwei Wege, wie Du Deinen Webshop an Sendcloud anbinden kannst:

Plug-and-Play-Integrationen

Wenn Du eine E-Commerce Plattform wie Shopify, WooCommerce, Lightspeed oder Magento benutzt, musst Du keine eigene Anbindung entwickeln, um Deinen Webshop zu verbinden. Wir bieten hier einfache "Plug-and-Play" Apps und Plugins für mehr als 80 der beliebtesten E-Commerce Plattformen an, die Du einfach aus dem Marktplatz bzw. App-Store des jeweiligen Shopsystems herunterladen kannst.

Sendcloud API

Wenn Du einen selbstgebauten Webshop verwendest, der nicht über eine E-Commerce-Plattform gehostet wird oder erstellt worden ist, kommen unsere APIs in Spiel. Eine API erlaubt es Entwicklern eine Verbindung zu unseren internen Systemen herzustellen und diese direkt in Deinen Webshop zu integrieren. Die Sendcloud APIs sind zu gestaltet, dass sie jede Phase des Versandprozesses abdecken.

Unsere Funktionen kannst Du in Verbindung miteinander oder eigenständig nutzen, was Dir die Flexibilität gibt, Deinen eigenen Arbeitsablauf von Anfang bis Ende zu gestalten und aufzubauen.

Bereit loszulegen? Dann lies weiter, um zu lernen, wie unsere APIs funktionieren.

Dokumentation und API Referenz

Wenn Du erfahrener Entwickler bist, der sich einfach schnell in unsere APIs einarbeiten möchte, kommst Du hier direkt zu unserer API Referenz oder Du greifst hier auf unsere Postman Collections zu.

Wenn Du neu im Bereich der APIs bist und eine ausführliche Erklärung darüber möchtest, wie Dein Bestellbearbeitungs-Workflow aussehen könnte, sieh Dir unsere API Dokumentation an. Hier findest Du eine Schnellstartanleitung und Tutorials, welche Dir die Grundlagen erklären, von der Erstellung Deines ersten Pakets über die API bis zur Erstellung von Multicollo-Sendungen um dem Vergleichen von Versandtarifen.

Was kannst Du alles mit unseren APIs tun?

• Shipping API
  Die Shipping API gibt Dir Zugriff auf die Kern-Features unserer Plattform. Du kannst Labels erstellen, Versandtarife vergleichen, Zolldokumente für Deine internationalen Sendungen erstellen und Deine Versandentscheidungen mithilfe von Versandregeln automatisieren.
• Service Points API
  Integriere eine Paketshop-Auswahl in Deinem Checkout, greife auf die Datenbank aller Paketshops von Versanddienstleister auf der ganzen Welt zu und lasse Deine Kunden einen bequemen Ort für die Zustellung ihrer Pakete wählen.
• Shipping Products API
  Vergleiche Versandtarife, Servicelevel und Zusatzleistungen von mehr als 50 Versanddienstleistern auf nationaler und internationaler Ebene.
• Return Portal API
  Lasse Deine Kunden ihre eigenen Retouren verwalten, indem Du eine eigene Version des Sendcloud Retourenportals erstellst. Verwende es zusammen mit unserer Funktion für bezahlte Retouren, um Kunden proaktiv eine Rücksendegebühr in Rechnung zu stellen.
• Tracking API
  Erhalte die gesamte Tracking-Historie eines Pakets, von dem Moment an, an dem das Paket angekündigt worden ist, bis zur Zustellung an Deinen Kunden.
• Pickups API
  Buche eine Einzelabholung mit einem Versanddienstleister Deiner Wahl und lasse Deine Pakete von Deinem Lager oder Deinem Shop zu einer bestimmten Uhrzeit abholen.
• Returns API V3
  Erstelle innerhalb weniger Minuten eigenständige Retouren für Pakete über die Returns API, selbst wenn das Paket ursprünglich nicht über Sendcloud versendet wurde. Greife auf eine Datenbank von Retourenmethoden zu und prüfe Deine Rücksendeanforderungen, bevor Du das Label erstellst. So vermeidest Du unerwünschte Kosten, wenn eine Retoure mit der von Dir gewählten Retourenmethode nicht möglich ist.
  
• Dynamic Checkout API
  Erhöhe deine Konversionsraten, indem du Lieferungen am nächsten Tag, am selben Tag oder am gewünschten Tag direkt auf deiner Checkout-Seite anbietest. Konfiguriere die Versandmethoden pro Lieferzone über das Sendcloud-Panel, rufe dann die anwendbaren Versandmethoden ab und stelle sie deinem Kunden auf deiner Checkout-Seite mit unserer API zur Verfügung.

Was ist eine API?

API steht für "Application Programming Interface" (Anwendungsprogrammierschnittstelle). Eine API sorgt dafür, dass Anwendungen über das Internet miteinander kommunizieren können. Um Daten von einer API abzurufen, erstellt man eine "Anfrage" in einer Formatierungssprache wie JSON oder XML oder einer Programmiersprache wie Python an einen Server und der Server gibt die angefragten Dateien in einer "Antwort" zurück. APIs sind dabei nicht nur eine Datenbank - neben der Abfrage von Daten kannst Du auch Daten aktualisieren, erstellen und löschen, indem Du API-Anfragen an bestimmte Endpunkte sendest. 

Die Sendcloud-Versand-API bietet Dir zum Beispiel Zugang zum Endpunkt "Paket erstellen". Du kannst eine Anfrage an diesen Endpunkt senden, um ein Paket in Sendcloud zu erstellen, indem Du dem Endpunkt die erforderlichen Informationen zur Verfügung stellst (Adressdaten, Informationen zur Versandmethode usw.). Um eine Anfrage zu stellen, musst Du wissen, welche Informationen unser Server benötigt, um das Paket zu erstellen. 

In unserer API Referenz findest Du Beispielanfragen und -antworten sowie eine Liste der erforderlichen und optionalen Felder, die Du angeben kannst.

Erste Schritte

Bist Du bereits für die Integration von Sendcloud-APIs? Bevor Du loslegst, stelle sicher, dass Du ein Sendcloud Konto erstellt und die Schritte aus dem Artikel "Starte mit Sendcloud" durchgeführt hast.

Du musst diesen drei Schritten folgen, damit unsere API Deine Anfragen akzeptiert:

1. Richte Deine Absender- und Retouren- (optional) Adressen ein.
2. Aktiviere mindestens einen Versanddienstleister
3. Richte eine Zahlungsmethode ein (wird benötigt, damit Du Labels erstellen kannst). Erfahre hier mehr darüber, wie Sendcloud Dir erstellte Labels in Rechnung stellt.

Optional: Vergiss nicht, eine Brand zu erstellen, Tracking Benachrichtigungen zu aktivieren und ein Retourenportal einzurichten.

Authentifizierung

Sendcloud verwendet "Basic Authentication", um Anfragen an unsere APIs zu authentifizieren. Du musst einen "öffentlichen" (Public) und "privaten" (Private) API-Schlüssel (Key) in den Header aller Aufrufe an einen Sendcloud-Endpunkt einfügen.

Beispiel: 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “DEIN_PUBLIC_API_KEY:DEIN_SECRET_API_KEY”

Weitere Beispiele für die Authentifizierung mit unseren APIs findest Du im Abschnitt "Authentication" in unserem Entwicklerportal.

Wie Du Deine API Keys erhältst

1. Melde Dich in Deinem Sendcloud Konto an und gehe zu Einstellungen > Integrationen
2. Finde den Eintrag "Sendcloud API" in der Liste der Integrationen und klicke auf Verbinden
   
3. Gib der API Integration einen Namens (z.B. "Mein Webshop" und klicke auf Speichern
4. Deine Public und Secret API-Keys werden automatisch generiert. Kopiere diese und füge sie dem Header Deiner API-Anfragen hinzu. Dein Public Key ist Dein "Username" bei der Authentifizierung und Dein Secret Key funktioniert wie ein Passwort.

Paketshops einrichten

Auf der Seite mit den Integrationseinstellungen, wie oben im Abschnitt "Authentifizierung" beschrieben, kannst Du auswählen, ob Du Paketshops aktivieren oder deaktivieren möchtest. Um Anfragen an die Service Point API zu erstellen, damit Du Pakete an einen Paketshop versenden oder verfügbare Paketshops in Deinem Checkout anzeigen kannst, musst Du Paketshops dort aktivieren.

Nachdem Du den Haken gesetzt hast, kannst Du Versanddienstleister auswählen, die Du für die Service Point Methoden zur Verfügung stellen möchtest. Klicke danach auf Speichern.

Testlabel erstellen

Mit der Versandmethode "Unstamped Letter" (unfrankierter Brief) kannst Du unsere APIs testen, ohne Dir Gedanken über anfallende Kosten zu machen. Für weitere Informationen zur Erstellung von Testlabels mithilfe der API, wirf einen Blick in unsere Dokumentation.

Häufig gestellte Fragen

Wenn Du noch Fragen zu Verwendung unserer APIs hast, kannst Du Dir unseren FAQ-Leitfaden für API-Integrationen ansehen.

IP-Adressen auf der Whitelist