Courrier - Les principaux paramètres

Lors de vos envois de courrier via l'API MySendingBox, de nombreuses options sont disponibles pour vous laisser choisir la couleur de l'impression, le format de l'enveloppe, le type d'affranchissement...

Pour plus de précisions sur l'API, consultez la documentation.

Obligatoire

Affranchissement

Paramètre : postage_type
Valeurs possibles : ecopli / prioritaire / lr / lrar

Consultez le guide sur l'affranchissement pour plus d'informations sur l'affranchissement.

Destinataire

Paramètre : to
Le destinataire est précisé grâçe au sous objet to.

Celui-ci doit contenir au minimum name ou company, address_line1, address_city, address_postalcode et address_country.

Chaque ligne d'adresse ne peut contenir plus de 38 caractères (en postage_speed : express ou 45 en postage_speed : D/D1). Si le name est trop long, vous pouvez le séparer et écrire le reste dans company.

L'adresse est construite ainsi :

name (si présent)
company (si présent)
address_line1
address_line2 (si présent)
address_line3 (si présent)
address_postalcode address_city
address_country

Consultez la documentation sur l'objet address pour plus d'informations.

Source de création

Paramètre : source_file, source_file_2, source_file_3, source_file_4 et source_file_5

Pour envoyer votre courrier à l'API, vous avez plusieurs options :

1. HTML
   Vous envoyez une chaîne de caractères HTML. Celle-ci sera rendue grâce au moteur MustacheJS qui permet d'intégrer des variables dans votre template. Consultez le guide sur la fusion de variables pour plus d'informations. Après avoir été rendu par MustacheJS, le HTML sera converti en un PDF.
   
2. Identifiant de template
   Vous pouvez passer l'identifiant d'un template précedemment créé depuis la section Templates de votre Dashboard. Le HTML récupéré sera traité de la même façon que si vous aviez envoyé une chaine de caractères HTML.
   
3. Fichier PDF
   Si vous avez déjà le fichier PDF que vous souhaitez envoyer, vous pouvez directement l'uploader.
   
4. URL d'un fichier distant
   Si vous avez déjà le fichier PDF que vous souhaitez envoyer et que celui-ci est accessible en ligne par nos serveurs alors vous pouvez directement passer l'URL de votre fichier.

Type de source

Paramètre : source_file_type, source_file_2_type, source_file_3_type, source_file_4_type et source_file_5_type

Valeurs possibles : html, template_id, remote or file.

Ce paramètre permet d'indiquer à l'API quelle option a été choisie pour l'envoi du source_file.

Couleur

Paramètre : color
Valeurs possibles : bw / color

Le paramètre color peut prendre comme valeur bw pour de l'impression en noir et blanc ou color pour une impression en couleur.

Optionnel

Recto/Verso

Paramètre : both_sides
Valeurs possibles : true / false
Par défaut : true

Position de l'adresse / Ajout d'une page porte adresse

Paramètre : address_placement
Valeurs possibles : first_page / insert_blank_page
Par défaut : first_page

Voir le guide sur les zones d'écrasement pour plus d'informations.

Vitesse d'envoi

Paramètre : postage_speed
Valeurs possibles : D1 / D / express

Pour plus d'informations à propos de la vitesse d'envoi suivez ce lien.

La valeur par défaut de ce paramètre peut être modifiée depuis votre Dashboard