B2B (v1)

Détail d’une lettre (champs exacts pour un fournisseur donné)

get/v1/letters/{slug}

Request

  • Base URL: https://api.vitef.com
  • URL: https://api.vitef.com/v1/letters/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Query parameters

providerstring

Response

Lettre

slugstring required
categorystring required
iconstring required
titlestring required
shortstring required
h1string required
badgestring required
urlstring required
providerLabelstring nullable required
signature'optional' | 'required' | 'paper'

optional : nom imprimé, signature dessinée possible (signatureImage) ; required : signature dessinée exigée avant l’envoi ; paper : PDF à imprimer et signer à la main (pas d’envoi postal).

signatureNotestring nullable

Explication à afficher quand la règle n’est pas optional.

introstring required
explainstring required
calculatorstring nullable required

Example response

{
  "slug": "resiliation-box",
  "category": "resiliation",
  "icon": "wifi-off",
  "title": "Résilier sa box internet",
  "short": "Free, SFR, Orange, Bouygues",
  "h1": "Lettre de résiliation box internet",
  "badge": "Conforme loi Chatel",
  "url": "https://vitef.com/lettres/resiliation-box",
  "providerLabel": "Votre fournisseur",
  "providers": [
    {
      "slug": "free",
      "name": "Free",
      "address": null,
      "url": "https://vitef.com/lettres/resiliation-box/free"
    }
  ],
  "fields": [
    {
      "key": "ref",
      "label": "Identifiant client",
      "type": "text",
      "optional": false,
      "placeholder": "12345678"
    },
    {
      "key": "recipientAddress",
      "label": "Adresse du destinataire",
      "type": "text",
      "optional": false,
      "placeholder": "Adresse complète",
      "autocomplete": "address"
    }
  ],
  "signature": "optional",
  "signatureNote": null,
  "intro": "Remplissez 3 champs, votre lettre de résiliation est prête. Téléchargez-la gratuitement ou laissez-nous l’envoyer en recommandé.",
  "explain": "La résiliation prend effet au plus tard 10 jours après réception de votre demande, sauf si vous demandez une date plus tardive (article L224-39 du Code de la consommation).",
  "tip": {
    "title": "Bon à savoir",
    "text": "Rendez le matériel dans le délai prévu par votre contrat pour éviter des frais de non-restitution."
  },
  "faq": [
    {
      "q": "Combien de temps prend la résiliation ?",
      "a": "10 jours au plus après réception de votre demande (article L224-39 du Code de la consommation)."
    }
  ],
  "provider": null,
  "senderFields": [
    {
      "key": "name",
      "label": "Prénom et nom",
      "type": "text",
      "optional": false,
      "placeholder": "Camille Martin"
    },
    {
      "key": "street",
      "label": "Adresse",
      "type": "text",
      "optional": false,
      "placeholder": "12 rue des Lilas",
      "autocomplete": "address"
    }
  ],
  "calculator": null
}

Changes

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