Sie befinden sich auf der Dokumentations-Seite der Paket DE Postnumber API für Post & Paket Deutschland. In den folgenden Kapiteln bieten wir Ihnen:

• Einen Überblick der fachlichen Funktionen die die API abdeckt
• Die technische Dokumentation der API
  • Das Anwenderhandbuch enthält Themen zu Verbindungen und Authentifizierung
  • DieOpen API Specifikation und Beispielaufrufe unter Referenzen
• Weiterhin finden Sie Themen zu Use Cases, FAQ, Support Contact und eine Postman Testsuite unter Postman Collection
• Aktuelle Release Notes

Umfang

Mit der DHL Paket DE Postnummern API werden über eine Postnummer registrierte Kunden identifiziert. Postnummern werden bei der Erstellung eines Versandlabels zur Adressierung der Sendung verwendet. Empfänger müssen ein Konto erstellen und ihre Identität auf dhl.de oder in der Post & Paket App bestätigen, um Sendungen an der Packstation (einem 24/7 Schließfachservice für den unbeaufsichtigten Empfang von Paketen) zu empfangen.

Sendungen, die an eine ungültige Postnummer adressiert sind, werden bei der Zustellung auf der letzten Meile aus dem Schließfach der Packstation abgewiesen, was zu unnötigen Kosten und schlechter Kundenzufriedenheit führen kann.

Voraussetzung zur Nutzung der API

Um die API zu nutzen, müssen folgende Voraussetzungen erfüllt sein:

• Sie brauchen einen gültigen Geschäfstkunden Account mit der DHL Paket GmbH

Benutzung der API

Funktionsweise der DHL Paket DE Postnummern API:

• Eingabeparameter sind: Vornamen, Nachnamen und Postnummern von Kunden
• Die API antwortet entweder mit dem Status "true" (korrekt/der Versand kann an diese Kombination aus Name und Postnummer adressiert werden) oder "false" (nicht gefunden)
• API-Benutzer können ihre eigenen Regeln auf der Grundlage der Antwort erstellen (z. B. zur Validierung von Formulareingaben in E-Commerce-Kassenprozessen)

Im Folgendem geben wir Ihnen einen Überblick wie Sie auf die API zugreifen können.

Get Access

Registrieren Sie Ihre DHL Paket DE Postnumber API um die API Zugriffsschlüssel zu bekommen:

Nutzen Sie den "Zugang erhalten" Link (es wird eine neue APP erzeugt) oder fügen Sie die API einer existierenden APP zu.

Bitte beachten Sie, dass die Sandbox APP keine weitere Freigabe bedarf, die produktive Nutzung wird explizit von uns freigegeben.

Authentifizierung

Access Token

Für den Zugriff auf APIs von Post & Paket Deutschland, müssen Sie sich zunächst gegen die Authentication API verifizieren. Im Austausch bekommen Sie einen Access Token, der für weitere API Zugriffe verwendet wird. Folgen Sie hierfür der Anleitung unter Authentication API (Post & Paket Deutschland).

Hinweis: Die Authentication API (Post & Paket Deutschland) wird Ihnen automatisch zugeordnet; Sie müssen nichts weiter tun.

Sandbox

Wir empfehlen Ihnen unsere Sandbox Umgebung für Ihre API Integration zu nutzen.

Username: "user-valid"
Password: "SandboxPasswort2023!"
Beschreibung: Valid Business Customer User

Diesen Nutzername und Passwort verwenden Sie bitte um über die Authenticatin API einen Access Token zu bekommen.

Der folgende curl Aufruf veranschaulicht die Abfrage eines Tokens sowie die Nutzung der Postnummern API:

curl -k -i -X POST -H "accept: application/json" -H 'content-type: application/x-www-form-urlencoded' https://api-sandbox.dhl.com/parcel/de/account/auth/ropc/v1/token -d 'grant_type=password&username=user-valid&password=SandboxPasswort2023!&client_id=lr8wTCJjcNnNL9HVYxQYTO6NGqlcGIGg&client_secret=hz0ofecvbAaEJxWF'

Mit dem validen Access Token können Sie die Postnummmern API nutzen:

Versuchen Sie den einfachen Zugriff der API version (ohne Access Token):

curl -H "accept: application/json" https://api-sandbox.dhl.com/parcel/de/account/postnumbers/v1/

Rufen Sie nun Informationen zu Kundendaten über die Postnummern API ab (mit Access Token):

curl -H "Authorization: Bearer ${TOKEN}" -H "accept: application/json"  https://api-sandbox.dhl.com/parcel/de/account/postnumber/v1/customers/871902603 --data '{"firstname" : "Max","lastname" : "Mustermann"}'

Valide Postnummern in unserer Sandbox Umgebung sind:

• Erika Mustermann mit der Postnummer 872467133
• Max Mustermann mit der Postnummer 871902603

Wir empfehlen die Verwendung der Software Postman zum testen der API. Postman ist eine Kollaborations Platform für API Entwicklung und Testing. Post & DHL Deutschland stellt Ihnen eine umfangreiche Postman Test Collection für jede API zur Verfügung. Folgen sie der Anleitung in diesem Kapitel um die Test Collection in Ihren Postman Workspace zu importieren und schnell mit der Integration unserer API zu beginnen.

Die folgenden Schritte müssen zuvor durchgeführt werden, um die API zu testen:

Sie müssen den Zugang zur Sandbox-Umgebung beantragen um einen API-Schlüssel (dhl-api-key) zu erhalten. Eine ausführliche Anleitung dazu finden Sie unter Zugang erhalten.

Einrichten der Postman Test Collection

*Laden sie die Postman Test Collection im Download Bereich herunter. *Importieren Sie die Postman Test Kollektion (siehe offizielle Dokumentation der Postman-Lernplattform) *Ersetzen Sie die Variablen API key (client_id) and an API secret (client_secret) mit Ihren persönlichen Werten.

Bitte beachten Sie auch unsere Schritt-für-Schritt Anleitung zur Benutzung der Postman Test Collection..