Sie befinden sich auf der Dokumentationsseite der DATAFACTORY AUTOCOMPLETE 2.0 API von Deutsche Post Direkt. In den folgenden Kapiteln bieten wir Ihnen:

• Einen Überblick über die von der DATAFACTORY AUTOCOMPLETE 2.0 API abgedeckten fachlichen Funktionen

• Die technische Dokumentation der API

  • Das Benutzerhandbuch beschreibt Verbindungen und Authentifizierung 

  • Open API Spezifikation in Referenzdokumentation

  • Code-Beispiele und Postman-Testsuite unter Downloads

• Im Kapitel Weitere Informationen finden Sie Kontaktinformationen zum weiterführenden Support.
   

Umfang

DATAFACTORY AUTOCOMPLETE von Deutsche Post Direkt bietet wirkungsvolle Unterstützung für die Adresserfassung. Als Webservice ist DATAFACTORY AUTOCOMPLETE vielseitig einsetzbar im Rahmen Ihres E-Business (von der Registrierung bis zum Check-out) oder auch im Kundenservice. Integriert in Ihre IT-Infrastruktur, werden postalische Daten auf Basis der Original-Postleitdaten der Deutschen Post ganz einfach und komfortabel ergänzt.
Bereits bei der Eingabe der ersten alphanumerischen Zeichen in das Eingabefeld erhalten Ihre Nutzer in Echtzeit bis zu 15 Vorschläge zur Vervollständigung der Adressfelder. Insgesamt umfasst der Datenpool rund 20 Millionen deutsche Anschriften inklusive Hausnummern, über 1,2 Millionen Straßennamen, 13.000 gültige Bestimmungsorte, 76.200 Ortsteilnamen und 35.200 Postleitzahlen in Verbindung mit den jeweiligen Bestimmungsorten sowie 10.000 PACKSTATIONEN.
Und auch wenn Sie Kunden in Österreich und der Schweiz haben, hilft Ihnen DATAFACTORY AUTOCOMPLETE bei der schnellen Adressvervollständigung und korrekten Adresserfassung. Denn für Österreich und die Schweiz einschließlich des Fürstentums Liechtenstein können Sie ebenfalls auf die korrekten postalischen Adressen bis einschließlich der Hausnummern zugreifen. Datenbasis der österreichischen Adressen ist die Datenbank Adress Data der Österreichischen Post AG. Adress Data bietet Ihnen alle postalisch erreichbaren Anschriften Österreichs. Die Prüfung Schweizer Adressen basiert auf Daten der Schweizer Post CH AG. Rund 12.000 Zustellende sammeln täglich neueste Angaben für aktuelle Adressen.

Benutzung der API

DATAFACTORY AUTOCOMPLETE 2 ist ein Dienst zur automatischen Vervollständigung von Adress- und Gebäudeinformationen. Der Dienst basiert auf Representational State Transfer (REST), einer IT-Architektur, mit der Webservices realisiert werden. Im Ergebnis können Sie DATAFACTORY AUTOCOMPLETE 2 besonders einfach integrieren.
Die Schnittstelle bietet zwei Funktionen. Die Funktion „search“ nimmt strukturierte Adressfragmente entgegen und liefert passende Vorschläge. Jeder dieser Vorschläge wird mit einer ID geliefert. Diese ID wird verwendet, um die Funktion „select“ aufzurufen, sobald einer der Vorschläge ausgewählt wird und dient zur Verbesserung der Generierung von Vorschlägen.

Vorschläge zur Eingabe

Ein Vorschlag stellt eine Vervollständigung der eingegebenen Daten dar. Folgende Arten von Anfragen stehen zur Verfügung, welche jeweils eindeutige Vorschläge zurückliefern. Die Auswahl erfolgt über die Auswahl des Aufrufpfades: 

• Vorschläge zur PLZ: /postalcodes 

• Vorschläge zu Orten: /cities 

• Vorschläge zu Ortsteilen: /districts 

• Vorschläge zu Straßen: /streets 

• Vorschläge zu Packstationen: ?address_type=p 

• Vorschläge zu Postfilialen: ?address_type=f 

• Vorschläge für mögliche Kombinationen aus PLZ und Ort: /postalcodes_cities 

• Vorschläge für mögliche Kombinationen aus PLZ, Ort und Ortsteil: /postalcodes_cities_districts 

• Vorschläge für mögliche Kombinationen aus PLZ, Ort und Straße: /postalcodes_cities_streets

• Vorschläge für mögliche Kombinationen aller Elemente 

• Vorschläge für Gebäudedaten inkl. Hausnummernzusatz: /buildings 

• Vorschläge für Postfächer: /poboxes 

• Vorschläge für Großempfänger: /bulkrecipients 

Jede Anfrage wird von DATAFACORY AUTOCOMPLETE mit bis zu 15 Vorschlägen beantwortet. Anhand von drei verschiedenen Adresstypen (A, F, P) kann eine Anfrage vorgefiltert werden.
Technische Beschreibung der Schnittstelle 

Technische Beschreibung
Bei der Schnittstelle handelt es sich um eine REST-Schnittstelle. Die Anfragen werden über HTTP GET Anfragen realisiert. Die Basis URL (Uniform Ressource Locator) für diesen Service lautet: 
https://autocomplete2.postdirekt.de/autocomplete2 

Im weiteren Verlauf werden die URI (Uniform Ressource Identifier) beschrieben, mit denen die Anfragen realisiert werden können. 
Hinweis: URI wird hier als Resource Identifier in Abgrenzung zu Resoure Locator URL verstanden 

Im Folgenden finden Sie einen Überblick, wie Sie Zugang zur API erhalten.

• Technische Details zu den API-Aufrufen finden Sie hier: "API Specification".

• Weitere Hinweise zur Verwendung der API finden Sie im Abschnitt "Additional Information".

Zugang erhalten

Voraussetzung für die Nutzung DATAFACTORY AUTCOMPLETE 2 ist eine Vertragsvereinbarung, die Autorisierung durch Freigabe seitens POST DIREKT, die Authentifizierung seitens des KUNDEN durch Eingabe von Benutzername und Passwort.

Freigabe beantragen:

Angebot anfordern

Deutsche Post Direkt GmbH
Junkersring 57
53844 Troisdorf
dataservices@postdirekt.de

Authentifizierung
Benutzer der Schnittstelle benötigen einen Account, der durch Deutsche Post Direkt die notwendige Autorisierung für AUTOCOMPLETE 2 erhalten hat. Die Authentifizierung als Inhaber dieses Accounts erfolgt mittels HTTP Basic Authentifizierung gegen die Token-Schnittstelle /token. Alle nachfolgenden Anfragen werden mittels eines sogenannten „Tokens“ durchgeführt, der bei der initialen Authentifizierung erstellt und an den Benutzer übermittelt wird. Erst wenn der Token ungültig wird (zeitlich begrenzt auf 15 min.), muss erneut der Benutzername und das Passwort für diesen Account in dem „Authorization“-Header eines HTTP-Request übermittelt werden. Der Nutzer hat diese Daten vor dem Zugriff Dritter zu schützen. 

Webservice Deutsche Post Direkt 

Fehlercodes

Jede Anfrage wird mit einem HTTP-Response beantwortet. Zunächst sollte der Status der HTTP-Response überprüft werden.
 

Kostenfreier Testzeitraum von 6 Wochen mit bis zu 4.000 Anfragen.

Testphase beantragen unter dataservices@postdirekt.de