Travailler avec l'API E-POSTBUSINESS

L'API E-POSTBUSINESS de Deutsche Post permet une automatisation fluide de l'envoi de lettres via la plateforme Document Dispatch. En intégrant cette API, l'ensemble du processus — de la création de documents numériques à la livraison physique des lettres — est entièrement automatisé, nécessitant aucun effort manuel.

L'API gère les étapes suivantes :

Impression – Convertit les documents numériques en lettres physiques
Mise sous enveloppe – Insère automatiquement les documents dans des enveloppes
Affranchissement – Prépare les lettres pour l'envoi postal

Une fois la lettre prête, Deutsche Post s'occupe de la livraison, éliminant toute intervention manuelle. Cette automatisation fait gagner du temps et réduit les coûts aux entreprises tout en garantissant une solution d'envoi fiable et efficace.

Info

Avant de pouvoir envoyer des lettres avec succès, l'API E-POSTBUSINESS doit être configurée. Vous pouvez trouver des instructions détaillées de configuration ici.

Création et envoi d'un document via E-POST

En utilisant l'API E-POSTBUSINESS, les utilisateurs peuvent envoyer des documents directement depuis Business Central sous forme de lettres.

Étapes pour créer et envoyer une lettre via l'API :

Accédez à un document (par exemple, une facture de vente enregistrée) dans Business Central.
Utilisez l'action Envoyer E-Post dans la boîte de faits Document Dispatch.
- Assurez-vous d'avoir un profil d'envoi pour la table à partir de laquelle un document doit être envoyé.
Ajoutez les documents ou pièces jointes souhaités et sélectionnez votre paramètre d'envoi spécifique. Ces paramètres incluent :
- Lettre recommandée
  - Lettre recommandée avec dépôt (Einwurf-Einschreiben) :
    - La lettre est livrée directement dans la boîte aux lettres du destinataire sans nécessiter de signature.
    - Cette option fournit un suivi de base et une preuve de livraison, confirmant que la lettre a été placée dans la boîte aux lettres.
    - Idéal pour des documents importants mais non critiques où une signature n'est pas nécessaire, tels que des notifications ou une correspondance générale.
  - Lettre recommandée (Einschreiben) :
    - La lettre est remise personnellement au destinataire ou à une personne autorisée en échange d'une signature.
    - L'expéditeur reçoit une confirmation que la lettre a été livrée, mais aucune preuve supplémentaire de qui l'a exactement reçue.
    - Convient pour des documents sensibles où une remise directe est nécessaire, tels que des contrats ou des avis légaux.
  - Lettre recommandée avec accusé de réception (Einschreiben mit Rückschein) :
    - En plus de la signature du destinataire, l'expéditeur reçoit une confirmation de livraison écrite (accusé de réception).
    - L'accusé de réception inclut le nom et la signature du destinataire, servant de preuve de réception légalement valide.
    - Recommandé pour des documents très importants ou juridiquement contraignants, tels que des lettres de résiliation, des avis légaux ou des communications officielles.
  - Lettre d'accompagnement
    - Ajoute une page de couverture à l'envoi, qui peut inclure des informations supplémentaires ou servir de séparateur entre différentes sections de documents.
  - Duplex
    - Permet l'impression recto verso (duplex) pour économiser du papier et rendre l'envoi plus respectueux de l'environnement.
  - Couleur
    - Spécifie si le document doit être imprimé en couleur ou en noir et blanc. Cela est utile pour les documents contenant des images ou des informations importantes codées par couleur.
Sélectionnez l'action OK.
Après la confirmation dans la boîte de dialogue, l'API envoie automatiquement le document à Deutsche Post, où il est imprimé et expédié.

Info

La combinaison de Duplex et Lettre recommandée n'est pas possible. Si vous sélectionnez Duplex, l'option Lettre recommandée sera désactivée. Cette fonction nécessite une connexion API active à Deutsche Post.

Envoi d'un document via E-POST à l'étranger

L'API E-POSTBUSINESS prend également en charge l'expédition internationale de documents. Pour envoyer un document à l'étranger, les configurations nécessaires doivent d'abord être complétées.

Étapes pour l'expédition internationale :

Accédez à votre destinataire, par exemple un client, désigné pour cette configuration.
Sélectionnez le destinataire et ouvrez la carte du destinataire.
Définissez le code pays/région du destinataire pour garantir un adressage correct pour l'envoi.
Dans le menu déroulant du champ code pays/région, accédez à la liste complète des pays/régions.
- Si le nom du pays/région est présent en allemand dans la liste complète des pays/régions, mais que la langue de l'environnement sélectionné de Business Central n'est pas allemande, passez à l'étape suivante.
- Sinon, si le nom et l'environnement sont en allemand, vérifiez simplement le nom du pays et s'il correspond à l'ISO 3166‑1, ajustez-le si nécessaire.
Si la langue de l'environnement n'est pas l'allemand, les traductions allemandes pour les noms de pays/régions doivent être saisies manuellement conformément aux exigences de Deutsche Post.
- Celles-ci peuvent être ajoutées via l'action Traductions sur la même page.
- Les traductions des noms de pays pour le code de langue DEU doivent respecter les normes ISO 3166‑1 et être saisies dans le champ Nom pour garantir un envoi correct.
Une fois la traduction terminée et l'adresse internationale configurée, vous pouvez envoyer le document comme d'habitude via l'action Envoyer E-Post dans la boîte de faits Document Central.

Info

Pour effectuer un auto-contrôle de la configuration, vous pouvez utiliser l'action Envoyer E-Post Dialog dans la boîte de faits Document Central. Si la configuration est correcte, la boîte de dialogue s'ouvrira et affichera le nom du pays en majuscules dans le champ Pays. Sinon, s'il y a une mauvaise configuration concernant la configuration d'expédition internationale, la boîte de dialogue ne s'ouvrira pas et générera une erreur.

Si l'envoi est effectué sans spécifier de code pays (c'est-à-dire, laissé littéralement vide), Deutsche Post le considère comme un envoi national. Il est donc nécessaire de compléter la configuration du code pays avant d'expédier à l'étranger.

Affichage de l'état d'envoi dans Business Central

Tous les envois, y compris les expéditions E-Post, sont listés et enregistrés dans la File d'attente Document Dispatch. Dans cette file d'attente, il existe une action spécifique pour les entrées E-Post appelée "Informations E-Post".

En sélectionnant cette action, une page s'ouvre affichant les informations suivantes :

Informations générales

Numéro d'entrée
Document source
Indicateur de mode test
Date de la dernière mise à jour de l'état

Informations sur la lettre

ID de la lettre
Options d'envoi sélectionnées

Informations sur le destinataire

Nom du destinataire
Adresse du destinataire

Suivi de l'état

Une ListPart enregistre tous les états interrogés, chacun associé à un ID d'état et un code d'état.

ID d'état et explications :

1 - Acceptation de l'envoi - L'envoi a été transmis avec succès, et aucune violation de schéma ou de contenu n'a été détectée dans le JSON. - Placement de l'état : Après le téléchargement réussi de l'envoi.

2 - Traitement de l'envoi - Le PDF a été vérifié pour la conformité E-Post et est approuvé pour l'impression. - Remarque : Malgré des vérifications approfondies, des erreurs techniques dans le PDF peuvent entraîner des échecs de traitement au centre d'impression, entraînant un État 99. - Placement de l'état : Quelques minutes après l'acceptation de l'envoi.

3 - Soumission au centre d'impression - L'envoi a été transféré au centre d'impression pour production. - Remarque : Si des erreurs techniques provoquent un échec de traitement, un État 99 sera émis au lieu de État 4. - Placement de l'état : Dans les heures suivant le traitement.

4 - Traitement au centre d'impression - L'envoi a été marqué comme "envoyé" par le centre d'impression. - Placement de l'état : 1 à 2 jours ouvrables après la soumission au centre d'impression.

99 - Erreur de traitement - Voir la liste des erreurs pour plus de détails.

État d'entrée de la file d'attente

L'état d'une entrée de file d'attente est mis à jour en fonction des étapes du processus. Une fois l'état "4" (Traitement au centre d'impression) atteint, l'entrée est marquée comme "envoyée".

Après un envoi E-Post réussi, l'entrée de la file d'attente se voit attribuer l'état "Envoi commencé". Cet état indique l'initialisation du processus d'expédition. Il sera automatiquement mis à jour avec tous les états de processus E-Post suivants, à condition que la file d'attente de travail "Mise à jour automatique de l'état des lettres E-Post Document Dispatch" soit en cours d'exécution.

Codes d'état et explications :

Erreurs : Nécessitent une action, traitement interrompu

E001 - Identifiants invalides – Vérifiez les détails de connexion
E002 - Identifiants invalides – VendorSubID incorrect
E003 - Trop de demandes SMS – Bloqué pendant 15 minutes
E004 - EKP bloqué par Deutsche Post
E101 - Jeton invalide – Expiré
E201 - Requête d'état invalide – Aucun envoi trouvé
E203 - Écart de métadonnées d'adresse détecté
E301 - Aucun format PDF reconnu
E302 - Violation de la zone restreinte DVF
E303 - Taille de fichier maximale de 20 Mo dépassée
E304 - Nombre de pages maximum de 94 dépassé
E305 - Code pays invalide
E306 - Format d'adresse du destinataire invalide
E307 - Première page en format paysage
E308 - Format non-DIN A4 détecté
E309 - Nom de fichier dupliqué détecté
E311 - Combinaison invalide : Lettre recommandée et expédition internationale
E312 - Combinaison invalide : Duplex + Lettre recommandée
E313 - Violation de schéma de lettre
E314 - La taille du fichier de la page de couverture dépasse 1 Mo
E315 - Erreur de traitement dans l'envoi
E316 - Erreur de téléchargement
E317 - Format de lettre recommandée invalide
E318 - Rejet au centre d'impression
E319 - EKP non approuvé pour le centre d'impression – Envoi en direct impossible
E320 - Nombre maximum d'envois de test par jour atteint
E322 - Fréquence de demande d'état trop élevée – Minimum de 5 secondes entre les demandes
E323 - Aucun contenu détecté dans la zone du destinataire (page blanche)
E333 - Adresse de l'expéditeur absente sur le document.
E399 - Erreur générale
E501 - État de l'API : Inactif
E601 - Erreur de plugin
E900 - Erreur non spécifiée

Avertissements : Peuvent nécessiter une action, mais le traitement continue

W101 - Avertissements de conversion PDF/A
W201 - Zone d'adresse dépassée
W202 - Zone restreinte laissée dépassée (sera blanchie)
W203 - Écarts de métadonnées d'adresse
W220 - À partir du 01.10.2022, les détails d'adresse de l'accusé de réception sont automatiquement extraits de la zone visible de l'expéditeur de la lettre
W301 - Adresse de l'expéditeur manquante (à partir du 01.07.2025, l'absence d'une adresse d'expéditeur sur les documents soumis sera considérée comme une erreur (“E333”)).
W501 - État de l'API : Avis de maintenance
W601 - Avertissement de plugin

Messages d'information : Aucune action requise

I101 - Option supplémentaire : Conversion PDF en PDF/A
I501 - État de l'API : OK
I601 - Info plugin
I701 - Mise à jour de l'état de suivi et de traçabilité
I751 - Message d'état pour la région de destination

Vérification de l'état de l'API E-Post

Document Dispatch fournit un moyen intégré de surveiller l'état de votre connexion à l'API E‑POSTBUSINESS.

Suivez les étapes ci-dessous pour vérifier l'état de l'API EPOST Business :

Nous commençons dans le rôle Administrateur Document Dispatch.
Ouvrez Configuration du module depuis le menu Configuration dans la barre de ruban.
Cliquez sur E-Post dans le menu Configuration du module Document Dispatch.
Exécutez l'action Vérification de l'état de l'API E-Post.

Vous recevrez des informations directement de l'API E‑POSTBUSINESS de Deutsche Post.

Journal de la file d'attente pour les entrées E-Post

Le Journal de la file d'attente Document Dispatch suit les événements liés à chaque type d'envoi, mais pour les entrées E-Post, le journal fournit un historique détaillé des actions d'envoi et inclut des entrées telles que :

Quand une lettre E-Post a été envoyée avec succès.
Si une lettre a été envoyée en mode test.
Toute erreur système ou échec survenu pendant le processus d'envoi.

Les utilisateurs peuvent consulter les journaux de la file d'attente dans la File d'attente Document Dispatch avec l'action Voir le journal, leur permettant de surveiller les activités d'envoi et de diagnostiquer d'éventuels problèmes.

Journal E-Post

Le Journal E-Post fournit un audit détaillé des actions système liées à E-Post, y compris :

Tentatives de connexion : Tentatives d'authentification réussies et échouées.
Changements de mot de passe : Enregistre quand un mot de passe a été changé pour l'utilisateur de l'API E-POSTBUSINESS.
Tentatives de demande de code SMS : Quand un nouveau code SMS a été demandé avec succès et échoué pour l'authentification.

Le Journal E-Post permet aux administrateurs de suivre les changements et d'assurer la sécurité de l'API E-POSTBUSINESS.

Travailler avec le Paramètre d'Adresse Automatique

Le Paramètre d'Adresse Automatique aide à garantir que les adresses des destinataires sont positionnées correctement pour l'envoi de lettres E-Post.

Étapes pour utiliser le Paramètre d'Adresse Automatique :

Accédez par exemple à une facture de vente enregistrée dans Business Central.
Choisissez un enregistrement et sélectionnez l'action Envoyer E-Post dans la boîte de faits Document Dispatch.
Assurez-vous qu'une configuration de superposition d'adresse a été mise en place et activée (configurée dans Pièce jointe de profil d'envoi pour un Rapport, qui, si elle doit être utilisée correctement et interprétée, est la première pièce jointe dans la liste. De plus, la superposition doit être configurée pour la mise en page du rapport, qui est actuellement utilisée).
Lors de la génération d'une facture par exemple pour un envoi via E-Post, le système appliquera automatiquement la superposition d'adresse prédéfinie.
Vérifiez l'aperçu du document dans la boîte de dialogue pour vérifier que la superposition d'adresse a été correctement appliquée.
- L'adresse ajoutée automatiquement ne sera pas affichée dans l'aperçu. Elle sera appliquée après avoir été envoyée vers l'API E-POSTBUSINESS.
Continuez à envoyer le document en confirmant la boîte de dialogue avec l'action Ok.

En utilisant le paramètre d'adresse automatique, les utilisateurs peuvent garantir la conformité avec les exigences de format de Deutsche Post, réduisant les erreurs et optimisant l'efficacité de l'envoi.

Voir aussi

Configuration de l'API E-POSTBUSINESS