API Merci Facteur /templatePublipostage : Envoi du template de la lettre à envoyer en nombre

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/templatePublipostage

← Retour à la liste des endpoints de l'API Merci Facteur

POST /templatePublipostage — Envoi du template de la lettre à envoyer en nombre

Le template doit être un fichier au format DOCX, il peut contenir des zones de remplacement (ou champs de fusion) qui seront remplacés par des données contenues dans la source de données. Les champs de fusion dans le template doivent être de la forme ${prenom} (avec uniquement des lettres, chiffres et le caractère _).

Paramètres

Nom	In	Type	Description
`ww-service-id`	header	string	Votre service Id
`ww-access-token`	header	string	Un access token valide

Request body

Request body requis

application/x-www-form-urlencoded

Propriété	Type	Description
`typeTemplate`	string	Type de template envoyé ("file" pour une URL vers un fichier docx, ou "base64" pour un fichier encodé en base64).
`template`	string	URL du fichier docx, ou sa version encodée en base64.

Réponses

HTTP 200 — Objet contenant la validation du template et les champs de fusion à contrôler.

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error string le code d'erreur en cas d'erreur

templateValidation object Les informations du template. Il convient de contrôler les champs de fusion extraits pour vous assurer qu'il n'y a pas d'erreur.

Propriété	Type	Description
`timeTemplate`	integer	timestamp du template (ne pas modifier)
`template`	string	identifiant du template (ne pas modifier)
`inputs`	array<string>	champs de fusion détectés (important : à contrôler)

`key`	string	Clé de validation du template (ne pas modifier)
`nbPage`	integer	Nombre de page(s) détectée(s) dans la lettre (important : à contrôler)

HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant

HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant