Zum Inhalt

Einrichtung der Konfiguration für die E-POSTBUSINESS API

Die E-POSTBUSINESS API der Deutschen Post ermöglicht Unternehmen, digitale Dokumente direkt aus ihren Systemen als physische Briefe zu versenden. Durch die Integration dieser API in Document Dispatch lässt sich der gesamte Briefversand automatisieren. Dadurch entfallen manuelle Arbeitsschritte, während Effizienz und Prozessgeschwindigkeit erheblich gesteigert werden.

Voraussetzungen für die funktionale Anbindung

  1. Bevor Sie die API nutzen können, ist es erforderlich, einen entsprechenden Vertrag mit der Deutschen Post abzuschließen. Dieser regelt die Nutzung der E-POSTBUSINESS API und die damit verbundenen Dienstleistungen. Weitere Informationen finden Sie auf der E-POSTBUSINESS-API Webseite.

  2. Nach Vertragsabschluss erhalten Sie von der Deutschen Post die notwendigen Zugangsdaten für die API. Diese umfassen:

    • Kundennummer (EKP)

  3. Die E-POSTBUSINESS API ist als Feature in Document Dispatch verfügbar. Um die API nutzen zu können, muss dieses Feature in Ihrem Document Dispatch aktiviert sein.

Einrichtung der E-POSTBUSINESS API

Um Dokumente per Brief über die Deutsche Post versendet werden können, muss das Feature eingerichtet werden. Dieser Prozess umfasst die Eingabe der API-Zugangsdaten. Bitte folgen Sie den unten aufgeführten Schritten, um die E-POSTBUSINESS API in Document Dispatch einzurichten.

Important

Es wird unänderlich die VendorID der Simova GmbH verwendet. Diese ist hinterlegt und kann nicht geändert werden, da sie der Verweis ist, um Rückschluss auf den Verwender zu ziehen.

Schritte zur Ersteinrichtung der E-POST-API:

  1. Starten Sie im Document Dispatch - Adminrollencenter.
  2. Klicken Sie auf Einrichtung im oberen Menüband.
  3. Führen Sie die Aktion Moduleinrichtung aus.
  4. Navigiere zum Aktionsbereich E-Post und starte die Aktion E-POST Einrichtungsassistent.
  5. Für Nutzer ohne vorherige Secret-, sowie Passworteingerichtung, muss die Schaltfläche Ersteinrichtung verwenden.
  6. Folgen Sie den Anweisungen des Assistenten, um die API-Zugangsdaten einzugeben.
  7. Anschließend setzen Sie ein Passwort und geben den SMS-Code ein, den Sie an die bei der deutschen Post hinterlegten Nummer erhalten haben.
  8. Nach erfolgreicher Einrichtung der API-Zugangsdaten, werden auf der weiteren Seite des Assistenten die Zugangsdaten gesetzt, wie:
    • Kundennummer (EKP)
    • Passwort
    • API-Secret

Info

Das API-Secret wird nach dem Setzen des Passworts automatisch erstellt und angezeigt. Bitte speichern Sie dieses sicher ab, da es nicht erneut angezeigt wird.

Schritte zur Einrichtung mit vorhandenen Zugangsdaten:

Falls Sie bereits über alle erforderlichen Zugangsdaten verfügen, gehen Sie wie folgt vor:

  1. Starten Sie im Document Dispatch - Adminrollencenter.
  2. Klicken Sie auf Einrichtung im oberen Menüband.
  3. Führen Sie die Aktion Moduleinrichtung aus.
  4. Navigieren Sie zum Aktionsbereich E-Post und starten Sie die Aktion E-POST Einrichtungsassistent.
  5. Als Nutzer mit bereits vorhandenen Zugangsdaten verwenden Sie die Schaltfläche Login.
  6. Folgen Sie den Anweisungen des Assistenten, um die API-Zugangsdaten einzugeben.
  7. Geben Sie Ihre bereits vorhandenen Zugangsdaten ein:
    • Kundennummer (EKP)
    • Passwort
    • API-Secret
  8. Bestätigen Sie die Eingabe mit Finish, um die Einrichtung abzuschließen.

Die sensiblen Daten, wie das Passwort und das API-Secret, werden verschlüsselt im Isolated Storage abgespeichert.

Info

  • Falls die API-Zugangsdaten falsch sind, wird eine Fehlermeldung in der während der Durchführung des Assistenten angezeigt. Sie haben natürlich die Möglichkeit, die Daten erneut einzugeben.

Erstellung eines E-POST-Versandprofils

Damit Dokumente über die E-POSTBUSINESS API versendet werden können, muss zunächst ein Versandprofil für den Briefversand erstellt werden.

Schritte zur Einrichtung eines E-POST-Versandprofils:

  1. Wechseln Sie zur Rolle Document Dispatch – Administrator.
  2. Öffnen Sie Versandprofile aus dem Menü Einrichtung.
  3. Drücken Sie Neu, um ein neues Versandprofil zu erstellen.
  4. Geben Sie den gewünschten Namen im Feld Code ein, wählen Sie E-POST als Ausgabetyp und definieren Sie die Tabelle (z. B. 112 – Verkaufsrechnungskopf).
  5. Für dieses Versandprofil können dann zusätzliche Ausgabeoptionen definiert werden, wie z. B. Farbdruck oder Duplexdruck und, ob diese Feste also nicht verändert werden können.

Info

  • Der Ausgabetyp E-POST wird in Verbindung mit dem Berichtsausgabetyp PDF verwendet. Falls jedoch beispielsweise ein Bild als Anhang im .png-Format hinzugefügt wird, wird es automatisch in eine PDF-Datei für die optimale Verarbeitung der API konvertiert.

Konfiguration von Berichten für die optimale Adressplatzierung (Optional)

Benutzer können Voreinstellungen für den Briefversand hinterlegen. Diese Einstellungen können für jeden Bericht individuell konfiguriert werden, wobei nur der erste Anhang für die automatische Adressplatzierung verwendet und modifiziert wird.

  1. Erstellen Sie für die optimale Adressplatzierung eine neue Zeile des Versandprofilanhangs und wählen Sie den Anhang mit dem Typ Bericht.
  2. Führen Sie die Aktion Optionen in der Menüleiste aus.
  3. Unter dem Reiter E-Post Einrichtung, kann jetzt durch klicken auf das Feld Zur Adressüberlagerung die Adressüberlagerung eingerichtet werden.
  4. Wählen Sie unten in den Zeilen ihren gewüschten Bericht aus und nutzen Sie anschließend die Aktion "Wählen der Adressüberlagerung".
  5. Anschließend soll ein Bericht gedruckt werden, wobei dort ein beliebiger Datensatz ausgewählt werden kann.
  6. Nach der Wahl, kann dann auf dem gedruckten Bericht mit dem ausgewählten Layout die Adressüberlagerung angepasst werden.
    • Sie können den Bereich der Adressüberlagerung, durch halten der rechten Maustaste auswählen.
  7. Nachdem der Adressbereich ausgewählt wurde, können Sie ihre Eingabe durch die Aktion Fertig bestätigen.

Damit ist die Einrichtung der E-POSTBUSINESS API abgeschlossen, wodurch der automatische Briefversand aus Document Dispatch ermöglicht wird.

Siehe auch