1 - Lettres unitaires

Prévisualiser une lettre

Prévisualisation d'une lettre, en prévision d'un potentiel envoi ultérieur.

Cette méthode utilise les mêmes paramètres d'entrée que l'envoi immédiat et pour cette raison nous n'allons pas les redétailler ici. La différence dans le cas de la prévisualisation, est que votre courrier ne sera pas produit tant que vous n'aurez pas dans un deuxième temps appelé la méthode de validation, en précisant son UID (qui vous est fourni dans la réponse à la preview). Une fois la validation effectuée, votre courrier sera pris en compte par notre chaîne de production exactement comme dans le cas de l'envoi immédiat. Si vous ne validez jamais un courrier prévisualisé, il sera simplement ignoré par nos services.

La prévisualisation comporte des avantages :

  • connaître le prix du courrier avant de le soumettre définitivement à notre chaîne de production
    En effet : l'envoi direct renvoie également le prix, mais votre courrier est déjà parti en production. Ici vous pouvez prendre votre temps et valider quand vous voulez.
  • prévisualiser le courrier avant son envoi
    Lorsque vous effectuez une demande de prévisualisation, la réponse de l'API contient l'url vers votre document PDF final hébergé dans le cloud par nos services.

🎯 Au-delà de la consultation du prix, en quoi cette prévisualisation du document final peut être cruciale ?

Dans la description de l'envoi immédiat nous avons vu qu'il était possible d'apposer l'adresse destinataire (voire également expéditeur) sur la première page de votre document. En fonction de la taille d'enveloppe retenue, cet emplacement peut varier. Cette phase de prévisualisation vous permet donc d'être en maîtrise sur l'aspect final de votre lettre, en particulier pour vous assurer que cette incrustation d'adresse ne vient pas en surimpression d'informations contenues dans votre document d'origine.

Par ailleurs, si vous optez pour l'usage de variables, la prévisualisation sera également le moyen pour vous de contrôler l'aspect final de votre document une fois les champs de fusion appliqués à votre modèle.

Pour effectuer une prévisualisation, rien de plus simple : il vous suffit de récupérer dans la réponse provenant de notre API l'url vers le fichier PDF de prévisualisation :

"fichier_previsualisation" : {
"format":"pdf",
"url":"https://sandbox-example-file.servicepostal.com/c456984a48ed710f6a62dcb78dd65e89\_01-01-2666.pdf"
}

Dans un premier temps, vous pouvez coller ce lien dans un navigateur pour visualiser l'aspect final de votre courrier. Par la suite, et si vous souhaitez aller un cran plus loin en termes d'intégration, rien ne vous empêche d'exploiter cette url dans votre propre outil métier, pour que vos utilisateurs puissent visualiser le fichier, puis le valider dans un deuxième temps en tout sérénité.

Plus globalement, la méthode de prévisualisation est intéressante pour les nouveaux venus sur notre API car elle permet de se familiariser avec les paramètres d'entrée, comprendre leur impact en termes de présentation et gagner en confiance avant la mise en production.

post/lettres/previsualiser

Request

  • Base URL: https://sandbox-api.servicepostal.com
  • URL: https://sandbox-api.servicepostal.com/lettres/previsualiser
  • Auth: none declared

Response

Opération réussie

uidstring
type_enveloppe'c4' | 'c5' | 'c6'
enveloppe'fenetre' | 'imprime'
type_affranchissement'lrar' | 'lr' | 'suivi' | 'verte' | 'vertesuivi' | 'ecopli' | 'performance' | 'perfsuivi'
couleur'nb' | 'couleur'
recto_verso'recto' | 'rectoverso'
placement_adresse'premiere_page' | 'insertion_page_adresse'
surimpression_adresses_documentboolean
impression_expediteurboolean
ar_scanboolean
ar_expediteur_champ1string
ar_expediteur_champ2string
nom_entitestring
nom_dossierstring
nom_sousdossierstring
date_envoistring
referencestring
code_barreboolean
affranchissementstring
servicestring
totalstring
affranchissement_basestring

Prix <b>public</b> (non abonné) de l'affranchissement, hors taxes.

service_basestring

Prix <b>public</b> (non abonné) du service (hébergement des données et documents dans le cloud, papiers, encres, enveloppes, dépôt quotidien dans le circuit de distribution de La Poste), hors taxes. Pour obtenir un montant TTC, la TVA sur le service est de 20 % (à rajouter donc, si vous souhaitez un montant TTC)

total_basestring

Coût total <b>public</b> (non abonné) de votre courrier HT = prix de l'affranchissement HT + prix du service HT

Example response

{
  "uid": "l-3fe173a7820bbcb1d78f854eb1cc2738",
  "type_enveloppe": "c5",
  "enveloppe": "fenetre",
  "adresse_expedition": {
    "civilite": "M.",
    "prenom": "Jacques",
    "nom": "Martin",
    "nom_societe": "JM Productions",
    "adresse_ligne1": "12 rue du Gai Vigneron",
    "adresse_ligne2": "Bâtiment C",
    "code_postal": "33000",
    "ville": "BORDEAUX",
    "pays": "FRANCE"
  },
  "adresse_destination": {
    "civilite": "M.",
    "prenom": "Léon",
    "nom": "Zitrone",
    "nom_societe": "ORTF",
    "adresse_ligne1": "66 avenue des Champs Elysées",
    "adresse_ligne2": "Service secrétariat général",
    "code_postal": "75008",
    "ville": "PARIS",
    "pays": "FRANCE"
  },
  "fichier_previsualisation": {
    "url": "https://sandbox-example-file.servicepostal.com/c456984a48ed710f6a62dcb78dd65e89_01-01-2666.pdf"
  },
  "fichier": {
    "url": "https://sandbox-example-file.servicepostal.com/a4582584a690c5ddc20109df8ce7089c_01-01-2666.pdf"
  },
  "variables": {
    "reference_client": "CL-06310/07",
    "numero_facture": "FC-06310-2212",
    "civilite": "Monsieur",
    "prenom": "Léon",
    "nom": "Zitrone"
  },
  "fichier_annexes": [
    {
      "url": "https://sandbox-example-file.servicepostal.com/7d8ba22fe195c8e7ad14e2a36c190bfe_01-01-2666.pdf"
    }
  ],
  "type_affranchissement": "lrar",
  "couleur": "nb",
  "recto_verso": "rectoverso",
  "placement_adresse": "insertion_page_adresse",
  "surimpression_adresses_document": true,
  "ar_scan": true,
  "ar_expediteur_champ1": "Référence : CL-06310/07",
  "ar_expediteur_champ2": "Facture : FC-06310-2212",
  "code_barre": true,
  "affranchissement": "5.66",
  "service": "1.49",
  "total": "7.15",
  "affranchissement_base": "6.15",
  "service_base": "2.47",
  "total_base": "8.62"
}

Changes

No recorded changes to this operation across all 1 revision of this API.