Die INTERNETMARKE ist das Online-Porto für Brief-Produkte der Deutschen Post AG.
Geeignet für:
Erstellung, Kauf und Bezahlung von Marken für folgende Brief-Produkte:
- Postkarten und Briefe national (mit Zusatzleistungen Prio, Einschreiben Einwurf, Einschreiben Eigenhändig und Rückschein)
- Postkarten und Briefe international (mit Zusatzleistungen Einschreiben, Eigenhändig)
- Warensendungen national
Die Deutsche Post INTERNETMARKE-API ermöglicht den Online-Kauf von INTERNETMARKEN und die Bezahlung über eine individuelle, dem Endkunden zugordnete Portokasse.
Binden Sie jetzt die Deutsche Post INTERNETMARKE-API in Ihr eigenes Shop- oder Warenwirtschaftssystem ein. Frankieren Sie all Ihre Sendungen zeitnah, schnell und direkt aus Ihrer eigenen Anwendung.
Ihre Vorteile im Überblick:
- Schnelle Versandabwicklung direkt aus Ihrem System
- Einfache Anbindung der Schnittstelle
- Anpassbarkeit des Systems an Ihre Bedürfnisse
- Druck über Ihren Label-Drucker
In den folgenden Kapiteln bieten wir Ihnen:
- Einen Überblick über die fachlichen Funktionen der API
- Die technische Dokumentation der API
- Open API Spezifikation in Referenzdokumentation
- Postman-Testsuite unter Downloads
- Erläuterungen zur Nutzung der API mit einer Portokasse
- Kontaktinformationen zum weiterführenden Support
- Informationen zu Produkten und Preisen erhalten Sie durch optionales Einbinden der API Produkt-Web-Service (ProdWS)
Umfang
Die Deutsche Post INTERNETMARKE-API bietet Ressourcen für
- Benutzer-/Portokassenmanagement
- Internetmarkenerzeugung, -kauf und -erstattung sowie
- den Abruf von Druckformaten, nutzbaren Grafikmotiven und nutzerspezifischen Informationen.
Hinweis:
Es ist sinnvoll, mit der Implementierung der INTERNETMARKEN-API auch den ProduktWebService (ProdWS) einzubinden – hierdurch ist sichergestellt, dass ohne weiteren Aufwand immer die aktuellen Informationen zu Produkten und Preisen verfügbar sind.
Benutzung der API
Die Deutsche Post INTERNETMARKE-API behandelt:
Die AppResource stellt Funktionalitäten zu Kauf und Verwaltung von INTERNETMARKEN bereit:
- Erzeugung von Internetmarken für einzelne oder multiple Sendungen
- Bereitstellung der Frankiervermerke als PDF-Datei oder PNG-Grafiken (in ZIP-Datei)
- Automatische Abbuchung der Transaktionskosten von der zugeordneten Portokasse
- Erzeugung von Previews auf den Frankiervermerk als PDF- oder PNG-Dokument
- Abruf von Informationen bei Nutzung von Briefzusatzleistungen (wie Einschreiben), zwecks Erstellung eines Einlieferungsbelegs oder Nutzung einer Versandliste
- Direkte Aufladung der (zuvor authentifizierter) Portokasse über Lastschrift (bei gültigem SEPA-Mandat)
- Abruf von öffentlichen und nutzerindividuellen Grafikmotiven, Vertragsprodukten und individuellen Preisen
- Erstattung von gekauften, aber nicht genutzten Internetmarken.
Die UserResource ermöglicht
- die Autorisierung mittels einer gültigen Portokasse
- die Erzeugung eines Bearer Tokens für die Authentifizierung bei der Nutzung anschließender Ressourcenpfade
- die Anzeige des aktuellen Guthabens
- den Abruf des jeweiligen Benutzerprofils
Hinweis:
Die direkte Aufladung der Portokasse über die INTERNETMARKEN-API ist nur möglich, wenn Lastschrift-Daten registriert sind und ein aktuell gültiges Lastschriftmandat vorliegt.
Die Nutzung der alternativen Zahlungsart zum Laden einer Portokasse (PayPal) ist nur manuell über das Webinterface https://portokasse.deutschepost.de/portokasse/#!/ möglich.
Die ApiVersionResource dient zur:
- Abfrage von Informationen über die API und
- als Healthcheck zur Prüfung der Verfügbarkeit des Webservices.
Hinweis:
Wir empfehlen die Implementierung und Nutzung der Healthcheck-Ressource, um Fehler bei der Nutzung durch Nichtverfügbarkeit der API möglichst im Vorfeld auszuschließen.
Die folgende Tabelle gibt Ihnen Transparenz über die kommenden Abschaltungen älterer API Versionen. Die Begrifflichkeiten sind unterhalb der Tabelle genauer erklärt.
| API Version | Status | Deprecation Date | Sunset Date |
|---|---|---|---|
| INTERNETMARKE (SOAP) | Deprecated | 01.08.2024 | 31.12.2025 |
| INTERNETMARKE (REST) | Active |
Begriffsklärung:
Status "Active": Es wird empfohlen diese API Version zu nutzen.
Status "Superseded": Die API wurde durch eine neuere API Version ersetzt. Bitte wechseln Sie auf die "Active" API Version.
Status: "Deprecated": Der Service wurde eingestellt (mit oder ohne alternativen Service per API). Der Support der API Version ist limitiert auf nötige Fehlerbehebung und Sicherheitsupdates.
Status: "Retired": Die API steht seit dem Sunset Date nicht mehr zur Verfügung.
"Deprecation Date": Von diesem Datum an wird die API im Status "Deprecated" sein. Weiterentwicklung ist limitiert auf nötige Fehlerbehebung und Sicherheitsupdates.
"Sunset Date": The API wird von diesem Zeipunkt an nicht mehr erreichbar sein.
Um Ihre Software-Entwicklung bestmöglich zu unterstützen, bieten wir Ihnen unsere Postman-Testsuite hier zum Download an.
Das bekannte API-Tool Postman können Sie hier beziehen: Postman API Platform | Sign Up for Free
Zur Nutzung der Postman-Collection führen Sie bitte folgende Schritte durch:
- Zur Nutzung benötigen Sie einen Zugang zur Deutsche Post INTERNETMARKE API, den sie hier beantragen können
- Postman-Beispiele/Collection in Postman importieren (siehe offizielle Dokumentation der Postman-Lernplattform)
- Füllen des Postman-Environments mit Ihren kundenspezifischen Daten (Credentials aus Developerportal, kundenspezifische (Test-) Portokasse).
Hinweis:
Die Postman-Collection ist kein direkter Produktbestandteil der Deutsche Post INTERNETMARKE API, sondern dient lediglich Ihrer Unterstützung.
Über ein Feedback (Fehler, Verbesserungsvorschläge o.ä.) würden wir uns freuen.
Für die Nutzung der Deutsche Post INTERNETMARKE API benötigen Sie eine Portokasse. Für die Entwicklung stellen wir Ihnen eine Test-Portokasse zur Verfügung.
Nach der erfolgreichen Anbindung können Sie bzw. Ihre Kunden die Internetmarke sofort nutzen. Einzige Voraussetzung ist eine Portokasse, mit der die erstellten Internetmarken abgerechnet werden. Die Portokasse wird hier registriert.
Support und Unterstützung erhalten Sie in unserem Help Center. Eröffnen Sie im dort ein Ticket, um direkte Unterstützung durch den DHL-Support zu bekommen. Bitte beschreiben sie ihre Anfrage so detailliert wie möglich und senden sie uns nachvollziehbare Auszüge der Webservice-Kommunikation. Wir versuchen Ihnen so schnell wie möglich mit ihrem Problem zu helfen. Zu folgenden Zeiten sind wir für Sie erreichbar:
IT Kundensupport & Integration Post
Geschäftszeiten: Mo - Fr von 8:00 - 16:00 Uhr
Beim ProdWS handelt es sich um eine zusätzliche Schnittstelle (SOAP-API), mit der Sie auf einfache Weise die verfügbaren bzw. mit der Internetmarke nutzbaren Produktcodes abrufen können.
Der Zugang zum ProdWS kann jederzeit auf Wunsch freigeschaltet werden.
Hinweis:
Wird der ProdWS freigeschaltet, die Produkte aber nicht abgerufen, informiert Sie der Service ProdWS mehrmals täglich per E-Mails über neue Produkte.
Haben Sie sich zur Nutzung des ProdWS entschieden, so teilen Sie uns diesen Wunsch in einer separaten E-Mail an pcf-1click@deutschepost.de mit. Im Anschluss bekommen Sie weitergehende Hinweise und Informationen zur Nutzung des ProdWS.