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 Einschreiben Einwurf und Einschreiben Rückschein)
- Postkarten und Briefe international (mit Zusatzleistung Einschreiben)
- 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 authentifizierten) 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. Wir bieten Ihnen für Ihre Entwicklung die Möglichkeit, eine selbstregistrierte Portokasse dauerhaft auf eine nicht abgerechnete "Entwickler-Portokasse" umzustellen. Diese Portokasse ist rein zu Entwicklungszwecken und darf nicht produktiv genutzt werden!
Registrieren Sie im Web-Frontend der Portokasse eine neue Portokasse.
Nutzen Sie hierbei unbedingt eine reale Emailadresse, um Mitteilungen versenden und empfangen zu können.
Diese Portokasse darf vor der Umstellung nicht geladen oder anderweitig für die Internetmarkenerstellung genutzt werden!
Um die Umstellung durch uns zu beauftragen, senden Sie bitte eine Mail an it-csp@deutschepost.de
Teilen Sie uns unbedingt die ID der umzustellenden Portokasse (ersichtlich nach erfolgreicher Web-Anmeldung/Login in Ihrer Portokasse sowie die registrierte E-Mail-Adresse mit.
Nach erfolgreicher Umstellung erhalten Sie eine entsprechende Bestätigung per E-Mail.
Ihre neue Entwickler-Portokasse ist dann ab sofort in der API nutzbar. Sie können sie im Web-Frontend über die „Interne Aufladung“ mit (jeweils) bis zu 1.000€ aufladen.

Denken Sie daran, Ihre Geschäftsanwendung in jeder verwendeten Portokasse (produktive- und Entwickler-Portokassen) im Frontend freizugeben.
Sie finden diese Einstellungen unter „meine Daten -> Geschäftsanwendungen“ .
Bei der Erstnutzung einer Portokasse (Tokenabruf!) erhalten Sie eine entsprechende Mitteilung an Ihre Portokassen-Mailadresse.
Darüber hinaus erhalten Sie bis zur Applikations-Freigabe jeweils einen "401"-Error beim Abruf eines Tokens.
Sie haben Fragen zur Verfügbarkeit unserer APIs?
Im IT-Portal finden Sie aktuelle Informationen zu IT-Service-Vorfällen, geplanten Wartungsfenstern und allgemeinen Verfügbarkeiten. Auf Wunsch können Sie sich dort auch per PUSH-Benachrichtigung proaktiv informieren lassen.
Sie haben inhaltliche, fachliche Fragen zu unseren APIs?
Nutzen Sie die „Benachrichtigen“-Funktion auf dieser Seite, um künftig automatisch über fachliche Änderungen und Neuerungen dieser API informiert zu werden. Unter dem Menüpunkt „Notifications“ finden Sie zudem unsere zuletzt versendeten Ankündigungen.
Technischer Support & Hilfe
Für weiterführende Unterstützung besuchen Sie bitte unser IT-Portal. Dort können Sie ein Ticket eröffnen und erhalten direkte Hilfe vom DHL-Support. Bitte schildern Sie Ihre Anfrage möglichst detailliert und fügen Sie nachvollziehbare Auszüge der Webservice-Kommunikation bei. So können wir Ihnen schnell und gezielt weiterhelfen.
Customer Integration Services (CIS)
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.
Release 1.30
Rein redaktionelle Anpassungen in Beschreibungen von bspw. Ressourcen-Pfaden, Attributen und Beispielen.
Release 1.29
fachlich
- Einführung einer Entwicklerportokasse an Stelle der bisherigen Testportokassen
- aktuell valide Testportokassen bleiben gültig bis Ablaufdatum
technisch
- mit Entwicklerportokasse erzeugte Marken enthalten "Muster"-Vermerk
Release 1.28
Hinweis auf Notwendigkeit für einmalige Registrierung der Anwendung in der genutzten Portokasse. Dies muss für jeden Nutzer der REST-Anwendung einmalig durchgeführt werden. Eine entsprechende Hinweismail erfolgt bei der ersten Nutzung an die mit der Portokasse verknüpfte Emailadresse.
Vgl. Abschnitt „Erläuterungen zur Nutzung der API mit einer Portokasse“
Release 1.27
- Das Objekt CashOnDelivery wurde auf deprecated gesetzt: Durch die Einstellung des Service Nachnahme Brief ist es nicht mehr verwendbar.
- Anpassung Objekt AppShoppingCartPosition: Entfernung des Elements additionalInfo aufgrund fehlender Bedeutung.
Release 1.26
Behebung eines Dokumentationsfehlers
Änderung: Der Parameter zur Finalisierung von Shoppingcarts ist „directCheckout“.
Details: In der Spezifikation und der Dokumentation wurde dieser Parameter fälschlicherweise bisher als „finalize“ bezeichnet. Dieser Fehler wurde nun korrigiert, sodass die Dokumentation jetzt den korrekten Parameter „directCheckout“ verwendet.
Beispiel: https://api-eu.dhl.com/post/de/shipping/im/v1/app/shoppingcart/pdf?directCheckout=true
Notifications
Deutsche Post INTERNETMARKE (Post & Paket Deutschland)
There have been content updates on the API Page Deutsche Post INTERNETMARKE (Post & Paket Deutschland).
You can have a detailed look at the changes by clicking the following link: Click here
Sincerely,
Your DHL API Developer Portal Team
You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription
Deutsche Post INTERNETMARKE (Post & Paket Deutschland)
There have been content updates on the API Page Deutsche Post INTERNETMARKE (Post & Paket Deutschland).
You can have a detailed look at the changes by clicking the following link: Click here
Sincerely,
Your DHL API Developer Portal Team
You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription