Merci Facteur imprime et poste vos courriers le jour même.
Une lettre
Une carte
Une photoAPI Merci Facteur : Détail des endpoints
← Voir tous les endpoints dans la doc Swagger
Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service
getToken
Fonction dans l'API Merci Facteur : Access token permettant l'accès à l'API
GET
IMPORTANT :
- Ne demander un access token qu'une seule fois par tranche de 24h. Après execution de getToken, stockez en local l'access token obtenu et refaites une demande lorsqu'il est expiré.
- Ne jamais faire transiter votre Secret Key non hashée.
`En savoir plus sur le hashage de la private key`
`En savoir plus sur les options de génération du token`
/getToken — Obtenir un access tokenIMPORTANT :
- Ne demander un access token qu'une seule fois par tranche de 24h. Après execution de getToken, stockez en local l'access token obtenu et refaites une demande lorsqu'il est expiré.
- Ne jamais faire transiter votre Secret Key non hashée.
`En savoir plus sur le hashage de la private key`
`En savoir plus sur les options de génération du token`
envoi-unitaire
Fonction dans l'API Merci Facteur : Envoyer un courrier à une ou plusieurs personnes (lettres, cartes, photos, recommandés électroniques)
publipostage
Fonction dans l'API Merci Facteur : Faire des envois en nombre de courriers personnalisés (lettres avec variables personnalisées)
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 _).
POST /sourcePublipostage — Envoi de la source de données du publipostage 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
POST /sendPublipostage — Envoi de la source de données du publipostage Validation de l'envoi d'un publipostage. Cela enclenche la fusion des données, la mise en production, l'impression et l'envoi de l'ensemble des lettres du publipostage.
gestion-courrier
Fonction dans l'API Merci Facteur : Gérer les courriers envoyés
DELETE
/deleteEnvoi — Annuler un envoi et son contenu Attention, opération irrémédiable. Selon le statut actuel des courriers, une demande d'annulation d'envoi pourra être rejetée immédiatement, rejetée après un certain délai, rejetée partiellement (annulation de l'envoi mais facturation partiellement annulée), ou acceptée intégralement (annulation de l'envoi et annulation intégrale de la facturation de cet envoi).
GET /getPostagePrice — Obtenir le montant d'un ou plusieurs courriers (non nécessaire à l'envoi) Vous permet d'avoir le montant de l'affranchissement et du contenu d'un courrier en fonction de son contenu, de son mode d'envoi et de sa destination. Vous n'avez pas besoin d'utiliser cette fonction pour envoyer un courrier, mais vous pouvez l'utiliser si vous avez besoin de cette information avant d'envoyer un courrier (par exemple pour des raisons de facturation). Le montant retourné est un montant HT. La partie "affranchissement" n'est pas soumise à la TVA.
GET /listEnvois — Lister les 50 derniers envois d'un utilisateur Cette opération liste les envois, sans entrer dans le détail de chaque envoi.Un envoi peut etre composé de plusieurs destinataires (une lettre identique envoyée a des destinataires différents). Un envoi peut donc contenir plusieurs courriers.
GET /getEnvoi — Lister les courriers d'un envoi en particulier Cette opération entre dans le détail des informations d'un envoi précis. Un envoi peut etre composé de plusieurs destinataires (une lettre identique envoyée a des destinataires différents). Un envoi peut donc contenir plusieurs courriers.
GET /getSuiviEnvoi — Obtenir le suivi et l'état des courriers d'un envoi Cette opération vous permet d'obtenir à n'importe quel moment l'état de courriers qui composent un envoi. Cet état correspond à l'état de l'impression du courrier jusqu'à sa remise à La Poste, et dans le cas des envois en LRAR ou en SUIVI, également l'historique du suivi de l'acheminement des courriers de la prise en charge par La Poste jusqu'à la distribution au destinataire.
GET /getProof — Obtenir les documents preuves d'un courrier (preuve de dépôt, preuve de réception, preuve de télechargement, etc.) Cela vous permet de récepérer les fichiers de preuves de vos courriers. Uniquement possible pour les courriers envoyés en Suivi, Recommandés avec avis de réception, ou Recommandé électroniques. Vous pourrez récupérer les preuves de dépôt (pour les suivi, les recommandés et les recommandés électroniques), les avis de réception (pour les recommandés avec avis de réception numérisé et les recommandés électropniques), ainsi que les preuves de télechargements (pour les recommandés électroniques). Les documents récupérés sont au format PDF ou JPEG.
GET /getLetterFinalFile — Récupérer le fichier PDF final d'une lettre après envoi (personnalisée en cas de publipostage) Cela vous permet de récupérer le fichier d'une lettre qui a été imprimée ou qui est en cours d'impression, au format PDF. Vous ne pouvez récupérer ce fichier que si il a déjà été imprimé ou si il est en cours d'impression (référez-vous à la réception de l'évènement webhook "printed" ou effectuez cette requète le jour ouvrable suivant le jour de la validation du courrier).
Fonction dans l'API Merci Facteur : Gérer les utilisateurs
POST
/setUser — Créer un nouvel utilisateur Chaque utilisateur aura un carnet d'adresses et un historique des envois. Vous retrouverez ces utilisateurs dans votre interface Merci facteur Pro. L'email indiqué doit être unique et vous permettre d'identifier l'utilisateur. Nous vous conseillons d'enregistrer en local les id d'utilisateurs retournés dans la réonse pour plus de confort d'utilisation de l'API.
DELETE /deleteUser — Supprimer un utilisateur Attention, opération irrémédiable. Cela ne supprimera pas ses adresses, ni ses courriers qui sont conservés sur votre compte Merci facteur Pro
GET /getUserId — Récupérer le user ID d'un utilisateur Récupérer le user ID à partir de l'adresse email. Pour utiliser cette fonction le moins possible, stockez les userId en local.
POST /updateUser — Modifier les informations d'un utilisateur Attention, toutes les informations doivent être envoyées, même si il n'y a pas des modifications sur toutes.
adress
Fonction dans l'API Merci Facteur : Gérer les adresses de vos utilisateurs
GET
Vous permet d'avoir la liste des pays disponibles, avec leur orthographe normalisée.
Au sujet des zones géographiques :
fr = France métropolitaine
om1 = GUADELOUPE, GUYANE FRANCAISE, MARTINIQUE, MAYOTTE, REUNION, SAINT BARTHELEMY, SAINT MARTIN, ST-PIERRE-MIQUELON
om2 = CLIPPERTON, NOUVELLE CALEDONIE, POLYNESIE FRANCAISE, TERRES AUSTRALES FR, WALLIS ET FUTUNA
z1 : UE sauf France
z2 : Reste du mondePOST
Cela peut-être une adresse d'expéditeur ou de destinataire. Les adresses sont liées à un utilisateur précis.
Vous ne pouvez pas créer plusieurs fois la même adresse, mais réutiliser les adresses créées.
Sont obligatoires : (nom et/ou société), (cp), (ville), (pays)
Pays doit être avec une orthographe conforme cf. getCountry()
Si une infos est inutilisée, tout de même l'envoyer en string vide.
Si vous ne souhaitez pas utiliser de carnet d'adresses, vous pouvez intégrer directement les adresses dans l'envoi des courriers, sans avoir recours à cette fonction avant.POST
Obtenir les informations d'une adresse enregistrée dans le carnet d'adresses.
/getCountry — Obtenir la liste des pays validesVous permet d'avoir la liste des pays disponibles, avec leur orthographe normalisée.
Au sujet des zones géographiques :
fr = France métropolitaine
om1 = GUADELOUPE, GUYANE FRANCAISE, MARTINIQUE, MAYOTTE, REUNION, SAINT BARTHELEMY, SAINT MARTIN, ST-PIERRE-MIQUELON
om2 = CLIPPERTON, NOUVELLE CALEDONIE, POLYNESIE FRANCAISE, TERRES AUSTRALES FR, WALLIS ET FUTUNA
z1 : UE sauf France
z2 : Reste du monde
/setNewAdress — Créer une nouvelle adresse dans le carnet d'adresses (non obligatoire pour l'envoi d'un courrier)Cela peut-être une adresse d'expéditeur ou de destinataire. Les adresses sont liées à un utilisateur précis.
Vous ne pouvez pas créer plusieurs fois la même adresse, mais réutiliser les adresses créées.
Sont obligatoires : (nom et/ou société), (cp), (ville), (pays)
Pays doit être avec une orthographe conforme cf. getCountry()
Si une infos est inutilisée, tout de même l'envoyer en string vide.
Si vous ne souhaitez pas utiliser de carnet d'adresses, vous pouvez intégrer directement les adresses dans l'envoi des courriers, sans avoir recours à cette fonction avant.
/updateAdress — Modifier une adresse dans le carnet d'adresses Cela peut-être une adresse d'expéditeur ou de destinataire. Sont obligatoires : (nom et/ou société), (cp), (ville), (pays) / pays doit être avec une orthographe conforme cf. getCountry() / Si une infos est inutilisée, tout de même l'envoyer en string vide.
DELETE /deleteAdress — Supprimer une adresse Supprime une adresse du carnet d'adresses. Attention, opération irrémédiable.
GET /listAdress — Lister les adresses du carnet d'adresses d'un utilisateur. Limité à 500 adresses. Pour plus de précision dans la recherche utilisez le paramètre "search".
GET /getAdressInfos — Obtenir les infos complètes d'une ou plusieurs adresse(s) à partir de leurs adresse Id (destinataire ou expéditeur).Obtenir les informations d'une adresse enregistrée dans le carnet d'adresses.
Fonction dans l'API Merci Facteur : Soliciter le Service Après Vente de Merci facteur pour un problème lié à un envoi
compte
Fonction dans l'API Merci Facteur : Gérer le compte Merci facteur Pro
GET
/getQuotaCompte — Obtenir les infos des quotas liés au compte Merci facteur Pro. Obtenir le montant restant sur le compte, la date d'expiration du plan, ainsi que le nombre de pages envoyées dans le mois.
POST /setWebhookEndpoint — Définir l'URL du endpoint sur laquelle les évènements liés à vos courriers seront envoyés via webhooks Définir l'URL du endpoint sur laquelle les évènements liés à vos courriers seront envoyés via webhooks. Pour supprimer l'URL et ne plus recevoir les évènement, envoyez une chaine vide dans "url".
GET /getWebhookEndpoint — Obtenir l'URL de webhook parametrée sur le compte. Obtenir l'URL de webhook parametrée sur le compte (URL sur laquelle seront envoyé les évènements liés à vos courriers). Si aucune URL webhook n'est renseigné, vous recevrez une chaine de caractères vide.
errors
Fonction dans l'API Merci Facteur : Gérer les erreurs retournées par l'API
