API Merci Facteur /sourcePublipostage : Envoi de la source de données du publipostage

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/sourcePublipostage

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

← Voir ce endpoint dans la doc Swagger

POST /sourcePublipostageEnvoi de la source de données du publipostage
 
Voir dans Swagger →

La source de donnée contient les informations de vos destinataires. Elle peut être au format CSV/TXT (; entre les champs, et saut de ligne entre les lignes, la première ligne doit contenir les champs de fusion), ou au format json (de la forme [{"prenom":"Jean-Marc", "ville":"Paris", "champ_de_fusion":"valeur"},{"prenom":"Julie", "ville":"Lyon", "champ_de_fusion":"valeur"}]). Votre fichier source doit au minimum contenir les champs de fusion suivants : "nom" ou "societe", "cp", "ville", "pays". Dans le cas d'un fichier CSV ou TXT, la première ligne doit être : civilite;nom;prenom;societe;adresse1;adresse2;adresse3;cp;ville;pays

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide

Request body

Request body requis

application/x-www-form-urlencoded
PropriétéTypeDescription
idUserintegerId de l'utilisateur qui effectue l'envoi.
templateValidationobjectun json avec la valeur templateValidation telle qu'elle vous a été retourné lors de l'envoi du template sur /templatePublipostage.
sourceobjectURL du fichier csv/txt, sa version encodée en base64, ou le json des données.
PropriétéTypeDescription
typestringType de source envoyée ("file" pour une URL vers un fichier CSV ou TXT, "base64" pour un fichier CSV ou TXT encodé en base64, ou "json" pour un json).
valuestringSi type="file", l'URL du fichier. Si type="base64", la base64. Si type="json", un json contenant les données sources ([{destinataire 1},{destinataire 2},etc...])

Réponses

HTTP 200 — Objet contenant l'ID de l'envoi en vue de sa validation, ainsi que les données sources à contrôler. Vous pouvez ensuite, soit contrôler manuellement le publipostage avant de la valider (via votre interface Merci facteur Pro), soit le contrôler automatiquement et le valider avec \sendPublipostage

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
idEnvoiintegerIdentifiant de l'envoi pour procéder à sa validation
sourceValidationobjectLes champs de fusion avec un éventuel retraitement, tels qu'ils seront utilisés lors de la fusion pour créer les lettres finales.
HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle 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éTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant


imprimé en france depuis 2004