Skip to content

Configuration Setup for the E-POSTBUSINESS API

The E-POSTBUSINESS API from Deutsche Post enables businesses to send digital documents as physical letters directly from their systems. By integrating this API into Document Dispatch, the entire letter-sending process can be automated. This eliminates manual steps while significantly increasing efficiency and process speed.

Prerequisites for Functional Integration

  1. Before using the API, a contract with Deutsche Post must be concluded. This contract regulates the use of the E-POSTBUSINESS API and the associated services. More information can be found on the E-POSTBUSINESS API website.

  2. After signing the contract, Deutsche Post will provide the necessary API credentials, including:

    • Customer Number (EKP)

  3. The E-POSTBUSINESS API is available as a feature in Document Dispatch. To use the API, this feature must be activated in Document Dispatch.

Setting up the E-POSTBUSINESS API

To send documents as letters via Deutsche Post, the feature must be set up. This process involves entering the API credentials. Follow the steps below to set up the E-POSTBUSINESS API in Document Dispatch.

Important

The VendorID of Simova GmbH will be used unalterably. It is stored and cannot be changed, as it serves as the reference to deduce the user.

Steps for Initial Setup of the E-POST API:

  1. Start in the Document Dispatch – Admin Role Center.
  2. Click on Setup in the top ribbon menu.
  3. Execute the Module Setup action.
  4. Navigate to the E-Post action area and start the E-POST Setup Wizard.
  5. If you have not yet set up the Secret and Password, click Initial Setup.
  6. Follow the wizard instructions to enter the API credentials.
  7. Next, set a password and enter the SMS code received on the phone number registered with Deutsche Post.
  8. Once the API credentials are successfully set up, the wizard will display the following credentials:
    • Customer Number (EKP)
    • Password
    • API Secret

Info

The API Secret is automatically generated after setting the password and displayed once. Please store it securely, as it will not be shown again.

Steps for Setup with Existing Credentials:

If you already have all required API credentials, follow these steps:

  1. Start in the Document Dispatch – Admin Role Center.
  2. Click on Setup in the top ribbon menu.
  3. Execute the Module Setup action.
  4. Navigate to the E-Post action area and start the E-POST Setup Wizard.
  5. If you already have API credentials, click Login.
  6. Follow the wizard instructions to enter the API credentials.
  7. Enter your existing API credentials:
    • Customer Number (EKP)
    • Password
    • API Secret
  8. Confirm your entry by clicking Finish to complete the setup.

Sensitive data, such as the Password and API Secret, are stored securely in Isolated Storage.

Info

  • If the API credentials are incorrect, an error message will be displayed during the wizard execution. You will have the opportunity to re-enter the data.

Creating an E-POST Dispatch Profile

To send documents via the E-POSTBUSINESS API, a shipping profile must first be created for letter dispatch.

Steps to Create an E-POST Dispatch Profile:

  1. Navigate to Document Dispatch – Administrator Role.
  2. Open Dispatch Profiles from the Setup menu.
  3. Click New to create a new shipping profile.
  4. Enter the desired name in the Code field, select E-POST as the Output Type, and define the Table (e.g., 112 – Sales Invoice Header).
  5. Additional output options can be defined for this shipping profile, such as color printing or duplex printing, and whether these options should be fixed and non-editable.

Info

  • The E-POST output type is used in conjunction with the PDF report output type. If an attachment, such as an image in .png format, is added, it will automatically be converted into a PDF file for optimal API processing.

Configuring Reports for Optimal Address Placement (Optional)

Users can preset configurations for letter dispatch. These settings can be individually configured for each report, where only the first attachment is used and modified for automatic address placement.

  1. To optimize address placement, create a new row under Dispatch Profile Attachment and select an attachment of type Report.
  2. Click the Options action in the menu bar.
  3. Under the E-Post Setup tab, click Enable Address Overlay.
  4. Select the desired report in the rows and then use the "Select Address Overlay" action.
  5. A report should then be printed, allowing you to choose any dataset.
  6. Once selected, you can adjust the address overlay on the printed report with the selected layout:
    • The address overlay area can be selected by holding down the right mouse button.
  7. After selecting the address area, confirm your entry by clicking Finish.

With this, the E-POSTBUSINESS API setup is complete, enabling automated letter dispatch from Document Dispatch.

See Also