API Merci Facteur /getLetterFinalFile : Récupérer le fichier PDF final d'une lettre après envoi (personnalisée en cas de 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/getLetterFinalFile

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

← Voir ce endpoint dans la doc Swagger

GET /getLetterFinalFileRécupérer le fichier PDF final d'une lettre après envoi (personnalisée en cas de publipostage)
 
Voir dans Swagger →

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).

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide
referenceCourrierquerystringRéférence Merci Facteur du courrier, de la forme "1234-5678".

Request body

Aucun body.

Réponses

HTTP 200 — Document solicité sous la forme d'une URL signée valide 5 minutes

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
resultarray<object>Les infos de suivi de chaque courrier constituant cet envoi
Items:
PropriétéTypeDescription
urlstringURL signée et provisoire du fichier PDF
refCourrierstringRéférence Merci facteur du courrier
expireintegerTimestamp de la date d'expiration de l'URL (5 minutes par défaut)
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