Ga naar inhoud

Configuratie van de E-POSTBUSINESS API

De E-POSTBUSINESS API van Deutsche Post stelt bedrijven in staat om digitale documenten als fysieke brieven rechtstreeks vanuit hun systemen te verzenden. Door deze API te integreren in Document Dispatch, kan het hele verzendproces van brieven worden geautomatiseerd. Dit elimineert handmatige stappen en verhoogt de efficiëntie en snelheid van het proces aanzienlijk.

Vereisten voor functionele integratie

  1. Voordat u de API kunt gebruiken, moet er een contract worden afgesloten met Deutsche Post. Dit contract regelt het gebruik van de E-POSTBUSINESS API en de bijbehorende diensten. Meer informatie vindt u op de E-POSTBUSINESS API-webpagina.

  2. Na ondertekening van het contract verstrekt Deutsche Post de API-inloggegevens, waaronder:

    • Klantnummer (EKP)

  3. De E-POSTBUSINESS API is beschikbaar als een functie in Document Dispatch. Om de API te gebruiken, moet deze functie in Document Dispatch worden geactiveerd.

Configuratie van de E-POSTBUSINESS API

Om documenten als brieven via Deutsche Post te verzenden, moet de functie worden geconfigureerd. Dit proces omvat het invoeren van de API-inloggegevens. Volg de onderstaande stappen om de E-POSTBUSINESS API in Document Dispatch te configureren.

Belangrijk

De VendorID van Simova GmbH wordt onveranderlijk gebruikt. Deze is opgeslagen en kan niet worden gewijzigd, omdat het de referentie is om de gebruiker af te leiden.

Stappen voor de initiële configuratie van de E-POST API:

  1. Open het Administratief Rolcentrum van Document Dispatch.
  2. Klik op Configuratie in het bovenste menu.
  3. Voer de actie Module-instelling uit.
  4. Ga naar de E-Post sectie en start de E-POST Instellingswizard.
  5. Als u de Secret en het wachtwoord nog niet heeft ingesteld, klik dan op Initiële configuratie.
  6. Volg de instructies van de wizard om de API-inloggegevens in te voeren.
  7. Stel vervolgens een wachtwoord in en voer de SMS-code in die u heeft ontvangen op het geregistreerde telefoonnummer bij Deutsche Post.
  8. Nadat de API-inloggegevens correct zijn ingesteld, toont de wizard de volgende informatie:
    • Klantnummer (EKP)
    • Wachtwoord
    • API Secret

Info

De API Secret wordt automatisch gegenereerd nadat het wachtwoord is ingesteld en wordt slechts één keer weergegeven. Sla deze veilig op, want deze wordt niet opnieuw getoond.

Stappen voor configuratie met bestaande inloggegevens:

Als u al over alle benodigde inloggegevens beschikt, volg dan deze stappen:

  1. Open het Administratief Rolcentrum van Document Dispatch.
  2. Klik op Configuratie in het bovenste menu.
  3. Voer de actie Module-instelling uit.
  4. Ga naar de E-Post sectie en start de E-POST Instellingswizard.
  5. Als u al API-inloggegevens heeft, klik op Inloggen.
  6. Volg de instructies van de wizard om de API-inloggegevens in te voeren.
  7. Voer uw bestaande inloggegevens in:
    • Klantnummer (EKP)
    • Wachtwoord
    • API Secret
  8. Bevestig uw invoer door op Voltooien te klikken om de configuratie af te ronden.

Gevoelige gegevens, zoals het wachtwoord en de API Secret, worden veilig opgeslagen in Isolated Storage.

Info

  • Als de API-inloggegevens onjuist zijn, wordt een foutmelding weergegeven tijdens de uitvoering van de wizard. U krijgt de kans om de gegevens opnieuw in te voeren.

Aanmaken van een E-POST verzendprofiel

Om documenten via de E-POSTBUSINESS API te verzenden, moet eerst een verzendprofiel worden aangemaakt.

Stappen om een E-POST verzendprofiel aan te maken:

  1. Ga naar de Administrator Rol in Document Dispatch.
  2. Open Verzendprofielen vanuit het menu Configuratie.
  3. Klik op Nieuw om een nieuw verzendprofiel aan te maken.
  4. Voer de gewenste naam in het veld Code in, selecteer E-POST als Uitvoertype en definieer de Tabel (bijvoorbeeld 112 – Verkoopfactuurkop).
  5. Voor dit verzendprofiel kunnen aanvullende uitvoeropties worden gedefinieerd, zoals kleurenafdruk of dubbelzijdig afdrukken, en of deze opties vast moeten staan en niet gewijzigd kunnen worden.

Info

  • Het E-POST uitvoertype wordt gebruikt in combinatie met het PDF-rapport uitvoertype. Als een bijlage in .png-formaat wordt toegevoegd, wordt deze automatisch geconverteerd naar een PDF-bestand voor optimale verwerking via de API.

Configuratie van rapporten voor optimale adrespositionering (Optioneel)

Gebruikers kunnen vooraf instellingen configureren voor het verzenden van brieven. Deze instellingen kunnen individueel per rapport worden aangepast, waarbij alleen de eerste bijlage wordt gebruikt en aangepast voor automatische adrespositionering.

  1. Om de adrespositionering te optimaliseren, maakt u een nieuwe rij onder Verzendprofiel Bijlage en selecteert u een bijlage van het type Rapport.
  2. Klik op de actie Opties in de menubalk.
  3. Onder het tabblad E-Post Instellingen, klik op Adresoverlay inschakelen.
  4. Selecteer het gewenste rapport in de regels en gebruik vervolgens de actie "Adresoverlay selecteren".
  5. Er moet een rapport worden afgedrukt waarin u een willekeurige dataset kunt kiezen.
  6. Nadat u de keuze heeft gemaakt, kunt u de adresoverlay aanpassen op het afgedrukte rapport met de geselecteerde lay-out:
    • Het gebied voor de adresoverlay kan worden geselecteerd door de rechtermuisknop ingedrukt te houden.
  7. Nadat het adresgebied is geselecteerd, bevestigt u uw invoer door op Voltooien te klikken.

Hiermee is de configuratie van de E-POSTBUSINESS API voltooid, waardoor geautomatiseerde briefverzending vanuit Document Dispatch mogelijk wordt.

Zie ook