2 - Lettres en nombre

Vérifier vos données

Ce point de terminaison vous aide à constituer votre fichier d'adresses, en analysant ligne à ligne votre .csv pour s'assurer que le format est valide, et que les informations contenues dans les champs de chaque ligne permettent de constituer un pavé adresse aux standards de distribution courrier.

Un publipostage est constitué de deux éléments :

Un document principal et ses annexes

Ces documents peuvent être au format Word (.docx, .doc) ou Pdf. L'ensemble de vos documents annexes (si vous en avez) sera ajouté à la suite de votre document principal pour constituer chacun de vos courriers (dans l'ordre dans lequel vous les avez soumis dans le tableau des documents annexes).

Un document de données, au format .csv (fichier plat avec comme séparateur : point virgule)

Ce document doit respecter notre format d'import (voir-ci dessous le détail). Ces données sont importantes car elles vont permettre de constituer les informations suivantes :

  • Les pavés adresse de destination (colonnes obligatoires)
  • Les pavés adresse expéditeur, si vous souhaitez les stipuler (colonnes facultatives)
  • Les valeurs des potentiels champs de fusion que vous souhaitez remplacer, si vous en avez, dans votre document principal (colonnes facultatives)

Votre document de données peut contenir jusqu'à 20 champs de fusion. Au-delà, votre document sera considéré non valide.

💾 Format du fichier .csv

La première ligne de votre .csv doit être une ligne d'en-tête décrivant quelle information se trouve dans quelle colonne. L'ordre des colonnes importe peu, mais il faut à minima que les informations permettant de constituer une adresse destinataire valide s'y trouvent.

Nom du champ d'en-tête

Poids

NOM_DESTINATAIRE

1

PRENOM_DESTINATAIRE

0

NOM_SOCIETE_DESTINATAIRE

1

ADRESSE_LIGNE1_DESTINATAIRE

2

ADRESSE_LIGNE2_DESTINATAIRE

0

CODE_POSTAL_DESTINATAIRE

4

VILLE_DESTINATAIRE

8

PAYS_DESTINATAIRE

0

Pour qu'une ligne d'adresse destinataire soit considérée comme valide, le total des poids des colonnes renseignées doit être égal (ou supérieur) à 15. A titre d'exemple, si la première ligne de votre fichier .csv contient :

NOM_DESTINATAIRE;ADRESSE_LIGNE1_DESTINATAIRE;CODE_POSTAL_DESTINATAIRE;VILLE_DESTINATAIRE

et que tous ces champs sont renseignés sur vos lignes de données, alors vos adresses seront valides (car le poids total = 1+2+4+8=15). 👍

Si d'une ligne à l'autre certains champs sont présents ou absents ça n'est pas important, l'essentiel est que pour chaque ligne la somme des poids soit respectée. Le respect de cette contrainte vous permet de donner toutes les chances à vos courriers d'atteindre leurs destinataires, et de ne pas payer des courriers pour rien - qui autrement reviendraient dans nos services comme PND (plis non distribués).

Voici un exemple d'appel contenant 6 adresses OK et 4 adresses KO : (le fichier .csv correspondant est téléchargeable ici)

    {
        "voir_paves_adresses" : true,
        "voir_fichiers_adresses" : true,
        "contenu_base64" : "UFJFTk9NX0RFU1RJTkFUQUlSRTtOT01fREVTVElOQVRBSVJFO1JBSVNPTl9TT0NJQUxFX0RFU1RJTkFUQUlSRTtBRFJFU1NFX0xJR05FMV9ERVNUSU5BVEFJUkU7QURSRVNTRV9MSUdORTJfREVTVElOQVRBSVJFO0NPREVfUE9TVEFMX0RFU1RJTkFUQUlSRTtWSUxMRV9ERVNUSU5BVEFJUkU7UEFZU19ERVNUSU5BVEFJUkUNCkplYW4tUGF1bDtCZWxtb25kbztKb3NzIEJlYXVtb250IENPUlA7NDggYXZlbnVlIEplYW4gTU9VTElOOzs4NDU1MDtNT1JOQVM7RlJBTkNFDQpKZWFuLVBpZXJyZTtNYXJpZWxsZTtDb21tZSBMYSBMdW5lOzIgcnVlIGR1IE1hcsOpY2hhbCBMZWNsZXJjOzs3NTAwNztQQVJJUzsNCkJydW5vO0NyZW1lcjtFVFMgTCfDiVBFUlZJRVI7NSBCRCBQRVJTSElORzs7NzUwMTY7UEFSSVM7RlJBTkNFDQpBbGFpbjtERUxPTjtCT1VUSVFVRSBTSE9QOzQ2MSBPY2VhbiBCb3VsZXZhcmQ7UGVudGhvdXNlIDdCOzEwMDMxO01hbmhhdHRhbjvDiXRhdHMtVW5pcw0KSmVhbjtSb2NoZWZvcnQ7OzYyIHJ1ZSBPZGViZXJ0Ozs7UEFSSVM7RlJBTkNFDQpMaW5vOzs7MjEgQVYgSkVBTiBKQVVSw4hTOzs5MjUwMDs7RlJBTkNFDQpKZWFuO0dhYmluO1dpbnRlciBNb25rZXk7MTAgSW1wYXNzZSBKZXVuZS1QcmVtaWVyOzs0MjQ0MDtOT0lSw4lUQUJMRTtGUkFOQ0UNCk1pY2hlbDtDb25zdGFudGluO0ZFRUxJTkcgVEFUT087Ozs3NzE3MDtCUklFIENPTVRFIFJPQkVSVDtGUkFOQ0UNCk1hcmdvdDtSb2JiaWU7QmFyYmllIEluYy47MjI0IEhhbmRzb21lIEF2ZW51ZTs7RTEgOFJVO0xvbmRvbjtHcmFuZGUtQnJldGFnbmUNCkplYW47RHVqYXJkaW47OzIsIEFWIEhFTlJJIEJBUkJVU1NFOzs2OTEwMDs7RlJBTkNF"
    }

📌 Adresses expéditeurs

Les colonnes du fichier .csv doivent respecter la même convention que les adresses destinataires :

NOM_EXPEDITEUR; PRENOM_EXPEDITEUR; NOM_SOCIETE_EXPEDITEUR; ADRESSE_LIGNE1_EXPEDITEUR;
ADRESSE_LIGNE2_EXPEDITEUR; CODE_POSTAL_EXPEDITEUR; VILLE_EXPEDITEUR; PAYS_EXPEDITEUR

Si les courriers ne sont pas en recommandés, les adresses expéditeurs sont facultatives.

⚠ Au contraire si les courriers sont en recommandés (avec ou sans accusé de réception), les adresses expéditeurs sont obligatoires.
Les champs d'adresse requis sont les suivants :

  • Le prénom (PRENOM_EXPEDITEUR) OU le nom (NOM_EXPEDITEUR) OU la raison sociale (NOM_SOCIETE_EXPEDITEUR)
  • La première ligne d'adresse (ADRESSE_LIGNE1_EXPEDITEUR)
  • Le code postal (CODE_POSTAL_EXPEDITEUR)
  • La ville (VILLE_EXPEDITEUR)

Dans le cas où vos courriers ne sont pas en recommandés, les adresses expéditeurs pourraient vous être utiles dans les cas suivants :

  • Emplacement du pavé expéditeur

    Vous souhaitez que ces adresses apparaissent sous la fenêtre blister des enveloppes à double fenêtre, à l'emplacement dédié pour les adresses expéditeur

  • Vous souhaitez utiliser ces champs comme champs de fusion dans votre document principal

💡Vous pouvez utiliser l'ensemble des noms des champs stipulés dans la ligne d'en-tête de votre .csv comme champs de fusion de votre document principal. Le format d'un champ de fusion commence par deux dièzes (##) et finit par deux dièzes (##). Ainsi, si votre document principal contient par exemple une ou plusieurs occurences de ##NOM_DESTINATAIRE##, ce dernier sera substitué par sa valeur provenant de votre .csv, pour la ligne correspondante. Vous pouvez ainsi personaliser facilement vos courriers. Cela est vrai à la fois pour les champs expéditeur et destinataire, mais également pour vos propres champs; si par exemple votre .csv contient une colonne REFERENCE_CLIENT et que votre document principal contient le champ ##REFERENCE_CLIENT##, nous viendrons substituer pour chaque courrier ce champ par sa valeur présente dans la colonne correspondante (dans l'en-tête du .csv les noms ne doivent pas contenir les double dièzes ## au début et à la fin, juste le nom brut).

post/publipostages/checkcsv

Request

  • Base URL: https://sandbox-api.servicepostal.com
  • URL: https://sandbox-api.servicepostal.com/publipostages/checkcsv
  • Auth: none declared

Request body

voir_paves_adressesboolean

<br/>Grâce à cette option, vous pouvez obtenir dans la réponse deux listes : une liste d'adresses valides (telles qu'elles seront constituées pour vos courriers) mais surtout la liste potentielle d'adresses erronées, avec pour chacune d'elles le détail de l'erreur, vous permettant de corriger votre .csv.

voir_fichiers_adressesboolean

<br/>En activant cette option, nous vous renvoyons deux liens pointant vers deux fichiers : un .csv contenant l'ensemble des adresses valides, et un .csv contenant l'ensemble des adresses erronées. Dans ce fichier seront indiquées en fin de ligne la ou les raisons qui ont soulevé l'erreur. Cela vous permet donc, selon votre choix : <ul> <li>Pour un publipostage urgent : de passer un publipostage ASAP avec l'ensemble des adresses valides, pour faire partir vos premiers courriers au plus tôt</li> <li>Pour un publipostage moins urgent : de constituer petit à petit un fichier .csv dans lequel vous avez corrigé l'ensemble des adresses</li> </ul>

contenu_base64string

Votre fichier .csv, au format Base64

Example request

{
  "voir_paves_adresses": true,
  "voir_fichiers_adresses": true,
  "contenu_base64": "<Mettez ici le contenu de votre fichier .csv, au format Base64>"
}

Response

codeinteger
messagestring
nb_adresses_okinteger

Nombre d'adresses valides

nb_adresses_kointeger

Nombre d'adresses invalides

Example response

{
  "nb_adresses_ok": 150,
  "nb_adresses_ko": 8
}

Changes

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