API Merci Facteur /getProof : Obtenir les documents preuves d'un courrier (preuve de dépôt, preuve de réception, preuve de télechargement, etc.)
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/getProof
← Retour à la liste des endpoints de l'API Merci Facteur
← Voir ce endpoint dans la doc Swagger
/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.
Paramètres
| Nom | In | Type | Description |
|---|---|---|---|
ww-service-id | header | string | Votre service Id |
ww-access-token | header | string | Un access token valide |
trackingNumber | query | string | Numéro de suivi du courrier. |
document | query | string | Le document de preuve souhaité : depot (preuve de dépôt), reception (avis de réception), ou telechargement (preuve de téléchargement). |
Request body
Aucun body.
Réponses
application/json
| Propriété | Type | Description |
|---|---|---|
success | boolean | true si HTTP 200, sinon false |
error | string | le code d'erreur en cas d'erreur |
format_return | string | Le format du document (jpeg ou pdf). |
document | string | La base64 du document retourné. Pour créer le document en local ou l'afficher, associez-y la bonne entête en fonction du "format_return". |
application/json
| Propriété | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
success | boolean | true si HTTP 200, sinon false | |||||||||
error | object | Objet contenant les infos de l'erreur. | |||||||||
| |||||||||||
application/json
| Propriété | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
success | boolean | true si HTTP 200, sinon false | |||||||||
error | object | Objet contenant les infos de l'erreur. | |||||||||
| |||||||||||

Une lettre
Une carte
Une photo