Aller au contenu

Configuration de l'API E-POSTBUSINESS

L'API E-POSTBUSINESS de Deutsche Post permet aux entreprises d'envoyer des documents numériques sous forme de lettres physiques directement depuis leurs systèmes. En intégrant cette API dans Document Dispatch, l'ensemble du processus d'envoi des lettres peut être automatisé. Cela élimine les étapes manuelles tout en augmentant considérablement l'efficacité et la rapidité du processus.

Conditions préalables à l'intégration fonctionnelle

  1. Avant d'utiliser l'API, il est nécessaire de signer un contrat avec Deutsche Post. Ce contrat régit l'utilisation de l'API E-POSTBUSINESS et des services associés. Vous trouverez plus d'informations sur la page Web de l'API E-POSTBUSINESS.

  2. Après la signature du contrat, Deutsche Post fournira les informations d'identification de l'API, qui incluent :

    • Numéro de client (EKP)

  3. L'API E-POSTBUSINESS est disponible en tant que fonctionnalité dans Document Dispatch. Pour utiliser l'API, cette fonctionnalité doit être activée dans Document Dispatch.

Configuration de l'API E-POSTBUSINESS

Pour envoyer des documents sous forme de lettres via Deutsche Post, la fonctionnalité doit être configurée. Ce processus implique la saisie des identifiants de l'API. Suivez les étapes ci-dessous pour configurer l'API E-POSTBUSINESS dans Document Dispatch.

Important

L'ID du fournisseur de Simova GmbH sera utilisée de manière immuable. Elle est enregistrée et ne peut pas être modifiée, car elle sert de référence pour déduire l'utilisateur.

Étapes pour la configuration initiale de l'API E-POST :

  1. Accédez au Centre de rôles administrateur de Document Dispatch.
  2. Cliquez sur Configuration dans le ruban supérieur du menu.
  3. Exécutez l'action Configuration du module.
  4. Accédez à la section E-Post et lancez l'Assistant de configuration E-POST.
  5. Si vous n'avez pas encore configuré le Secret et le mot de passe, cliquez sur Configuration initiale.
  6. Suivez les instructions de l'assistant pour saisir les identifiants de l'API.
  7. Ensuite, définissez un mot de passe et entrez le code SMS reçu sur le numéro enregistré auprès de Deutsche Post.
  8. Une fois les identifiants de l'API correctement configurés, l'assistant affichera les informations suivantes :
    • Numéro de client (EKP)
    • Mot de passe
    • Secret de l'API

Info

Le Secret de l'API est généré automatiquement après la définition du mot de passe et n'est affiché qu'une seule fois. Veuillez le sauvegarder en toute sécurité, car il ne sera pas affiché à nouveau.

Étapes pour la configuration avec des identifiants existants :

Si vous possédez déjà tous les identifiants requis, suivez ces étapes :

  1. Accédez au Centre de rôles administrateur de Document Dispatch.
  2. Cliquez sur Configuration dans le ruban supérieur du menu.
  3. Exécutez l'action Configuration du module.
  4. Accédez à la section E-Post et lancez l'Assistant de configuration E-POST.
  5. Si vous possédez déjà des identifiants API, cliquez sur Connexion.
  6. Suivez les instructions de l'assistant pour saisir les identifiants de l'API.
  7. Saisissez vos identifiants existants :
    • Numéro de client (EKP)
    • Mot de passe
    • Secret de l'API
  8. Confirmez votre saisie en cliquant sur Terminer pour finaliser la configuration.

Les données sensibles, telles que le Mot de passe et le Secret de l'API, sont stockées de manière sécurisée dans Isolated Storage.

Info

  • Si les identifiants de l'API sont incorrects, un message d'erreur s'affichera lors de l'exécution de l'assistant. Vous aurez la possibilité de saisir à nouveau les données.

Création d'un profil d'envoi E-POST

Pour envoyer des documents via l'API E-POSTBUSINESS, un profil d'envoi doit être créé au préalable.

Étapes pour créer un profil d'envoi E-POST :

  1. Accédez au Rôle Administrateur de Document Dispatch.
  2. Ouvrez Profils d'envoi depuis le menu Configuration.
  3. Cliquez sur Nouveau pour créer un nouveau profil d'envoi.
  4. Saisissez le nom souhaité dans le champ Code, sélectionnez E-POST comme Type de sortie et définissez la Table (par exemple, 112 – En-tête de facture de vente).
  5. Des options de sortie supplémentaires peuvent être définies pour ce profil d'envoi, telles que l'impression en couleur ou l'impression recto-verso, ainsi que la possibilité de les verrouiller pour qu'elles ne soient pas modifiables.

Info

  • Le type de sortie E-POST est utilisé en combinaison avec le type de sortie de rapport PDF. Si une pièce jointe au format .png est ajoutée, elle sera automatiquement convertie en fichier PDF pour un traitement optimal via l'API.

Configuration des rapports pour un positionnement optimal des adresses (Optionnel)

Les utilisateurs peuvent configurer des paramètres prédéfinis pour l'envoi de lettres. Ces paramètres peuvent être personnalisés pour chaque rapport, où seul le premier fichier joint est utilisé et modifié pour le positionnement automatique des adresses.

  1. Pour optimiser le positionnement des adresses, créez une nouvelle ligne sous Pièce jointe du profil d'envoi et sélectionnez une pièce jointe de type Rapport.
  2. Cliquez sur l'action Options dans la barre de menu.
  3. Sous l'onglet Configuration E-Post, cliquez sur Activer la superposition d'adresses.
  4. Sélectionnez le rapport souhaité dans les lignes, puis utilisez l'action "Sélectionner la superposition d'adresses".
  5. Un rapport doit être imprimé pour vous permettre de sélectionner un jeu de données quelconque.
  6. Une fois sélectionné, vous pouvez ajuster la superposition d'adresses sur le rapport imprimé avec la mise en page choisie :
    • La zone de superposition d'adresses peut être sélectionnée en maintenant le bouton droit de la souris enfoncé.
  7. Après avoir sélectionné la zone d'adresse, confirmez votre saisie en cliquant sur Terminer.

Avec cela, la configuration de l'API E-POSTBUSINESS est terminée, permettant l'envoi automatisé de lettres depuis Document Dispatch.

Voir aussi