Die Authentication API ermöglicht es Ihnen, ein Token für den Zugang zu vielen Paket Deutschland APIs zu erhalten.

Diese API bietet eine einzelne Ressource /token und eine Testressource /hello, in der Sie die Token-bezogene Funktionalität ausprobieren können, bevor Sie sie mit APIs wie der Paket DE Retouren oder MyAccount API verwenden.

Ihr erster Aufruf

Einzelheiten zu Endpunkten, Operationen, Parametern und Formaten finden Sie in der technische Beschreibung (OAS / Swagger).

Weitere Informationen finden Sie im User Guide und in unseren Erklärungen über die Vorteile und die Nutzung der Authentication API.

Techischer Überblick

Die Authentifizierungs API ist eine gemeinsame Funktion, die von mehreren APIs genutzt wird. Sie wird verwendet, um ein Zugangs-Token für den API-Zugang zu erhalten. An sich bietet sie keine Geschäftsfunktionen, sondern unterstützt mehrere APIs von Post & Paket Deutschland.

Die API bietet eine Implementierung eines OAuth2.0 resource-owner-password-credentials flows. Token können für alle P&P-APIs verwendet werden, die die Authentifizierungsmethode unterstützen. Eine Liste der APIs finden Sie unten.

Zugang erhalten

Bitte folgen Sie den Anweisungen auf den Dokumentationsseiten der Business-API, die Sie verwenden möchten. Die Anmeldeinformationen (`client_id` und `client_secret`), die Sie dort erhalten haben, ermöglichen Ihnen auch die Nutzung dieser Funktion. Für die Authentifizierungs-API benötigen Sie keine zusätzlichen Anmeldeinformationen.

Einen Token anfragen

Der folgende `curl` Befehl veranschaulicht, wie man ein Token erhält.

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=max.mustermann\&password=MeinPasswort123#\&client_id=lr8wTCJjcNnNL9HVYxQYTO6NGqlcGIGg\&client_secret=hz0ofecvbAaEJxWF"

Umgebungen

In der folgenden Tabelle sind die wichtigsten Unterschiede zwischen den Umgebungen aufgeführt.

Testen der API

Sie können:

• die API direkt hier in der Sandbox-Umgebung ausprobieren (client_id und client_secret sowie vordefinierter Backend-Benutzer und -Passwort erforderlich)
• die mitgelieferte postman-Sammlung verwenden (client_id und client_secret erforderlich)
• Anpassen des curl-Beispiels

Der Endpunkt /hello ermöglicht das Testen mit dem neuen Token, das Sie erhalten haben.

Folgende APIs unterstützen die OAuth2 tokenbasierte Authentifizierung

DHL Parcel DE Pickup

DHL Parcel DE Shipping

DHL Parcel DE Returns

Parcel DE Postnumber

MyAccount API

Allgemeine Fragen

Ich möchte eine bestimmte API verwenden und bin einem Link zu dieser API gefolgt. Was ergibt sich daraus?

Diese API (Parcel DE Authentication) bietet eine Funktionalität, um ein OAuth-Access-Token zu erhalten. Mit diesem Token können Sie mehrere Parcel-APIs aufrufen.

Mein Setup funktioniert für getVersion(), aber ich erhalte HTTP 401 für alle anderen Aufrufe.

getVersion ist ein Aufruf an den Basispfad der API (z.B. https://api-eu.dhl.com/parcel/de/account/auth/ropc/v1/). Dieser Aufruf kann sogar von einem Browser aus erfolgen und erfordert keine Anmeldedaten.

Ich habe Zugang beantragt und 48 Stunden oder länger keine Antwort erhalten.

Bitte entschuldigen Sie. Bitte wenden Sie sich über das Kontaktformular an uns. Die Freigabe zur Produktion erfolgt nicht automatisch.

Go-Live

Werde ich für PROD und SANDBOX denselben Schlüssel verwenden?

Wenn Sie den Zugriff auf Sandbox- und Produktionsprodukte in derselben Anwendung beantragt haben, wird normalerweise derselbe Schlüssel sowohl für PROD als auch für SANDBOX aktiviert. Wir können Sie auf der Grundlage Ihrer Präferenzen einrichten. Wir können auch PROD-Zugang hinzufügen, wenn Sie ursprünglich nur Sandbox-Zugang beantragt hatten.

Token

Was ist das für ein Token?

Wir stellen ein undurchsichtiges Zugriffstoken (Beispiel: JU8VQkQaBHnKsphAuGQPKF1VAoBv) bereit, das als Bearer-Token im Header Authorization verwendet wird.

Brauche ich noch etwas anderes als das Access-Token?

Nein. Für Geschäftsaufrufe geben Sie einfach das Zugriffstoken im HTTP-Header an. Es ist kein zusätzlicher Berechtigungsnachweis erforderlich.

Wo kann ich weitere Informationen finden?

Die Implementierung folgt https://www.rfc-editor.org/rfc/rfc6749, bitte lesen Sie den RFC für weitere Details.

Ablauf des Tokens

Das Zugriffstoken läuft nach einer relativ kurzen Zeit ab (z. B. 30 Minuten). Nach Ablauf der Gültigkeit müssen Sie ein neues Token beantragen. Einzelheiten entnehmen Sie bitte dem OAS.

Testen

Wie sollte ich den "Hallo"-Endpunkt testen?

Der hello Endpunkt unterstützt sowohl tokenbasierte als auch traditionelle
(Schlüssel + Benutzer + Passwort) Authentifizierung. Er dient als Hilfe während der
Entwicklung.