Aller au contenu

L’API Vitef, intégrée vite fait

Une API REST en JSON pour générer des lettres conformes, les envoyer en recommandé, suivre chaque étape et récupérer les preuves. Chaque exemple existe en curl, JavaScript et Python.

CommencerObtenir ma clé test

Démarrage rapide

Créez votre compte développeur, récupérez votre clé test et générez puis envoyez votre première lettre recommandée simulée, en curl, JavaScript ou Python.

Authentification

Clés vf_test_ et vf_live_, en-tête Authorization Bearer, droits (scopes) de chaque clé, rotation et révocation, appels depuis votre serveur.

Bac à sable

Clés test : envois simulés, preuves fictives, IA simulée, webhooks réels et avancement manuel des envois. Quota quotidien et passage en production.

Erreurs

Format JSON des erreurs de l’API Vitef, liste des codes (invalid_api_key, insufficient_balance, address_invalid…) et statuts HTTP, avec la conduite à tenir.

Limites de débit

Nombre d’appels par minute et par clé, en-têtes RateLimit-Limit, RateLimit-Remaining et RateLimit-Reset, réponse 429 et Retry-After, quota du bac à sable.

Idempotence

En-tête Idempotency-Key : rejouez une requête après une coupure, sans doublon ni double débit pendant 24 h ; erreurs 409 et 422, dépôt en cours.

Pagination

Listes paginées par curseur (limit, cursor) : enveloppe data, nextCursor et hasMore, du plus récent au plus ancien, boucle en JavaScript et Python.

Lettres du catalogue

Parcourez le catalogue, lisez les champs d’une lettre pour un destinataire, obtenez son rendu (JSON, texte, champs manquants) ou son PDF A4 par l’API Vitef.

Envoyer un courrier

POST /v1/mailings : lettre simple, recommandée ou recommandée avec accusé de réception, depuis le catalogue ou une lettre libre, avec votre référence et votre signature.

Suivi et preuves

Étapes d’un envoi (imprimé, remis à La Poste, distribué, AR signé), numéro de suivi, preuve de dépôt et accusé de réception téléchargeables par l’API Vitef.

Webhooks

Recevez chaque étape de vos envois : liste des événements, corps JSON, en-têtes, vérification de la signature HMAC-SHA256 en Node.js, Python et PHP, nouvelles tentatives.

IA

Remplissage des champs d’une lettre depuis une phrase, lettre sur mesure rédigée par l’IA et outils IA du catalogue, facturés à l’unité et simulés en bac à sable.

Calculateurs

Exécutez les calculateurs Vitef (salaire brut en net, préavis, indemnités, frais…), les estimations de devis et le partage de dépenses par API : quota gratuit chaque mois, résultat prêt à afficher.

Entreprises, adresses, carburants

Recherchez une entreprise (SIREN, SIRET), géocodez une adresse, trouvez une commune, calculez un itinéraire et obtenez les prix des carburants par API, avec un quota gratuit chaque mois.

Crédit et facturation

Crédit prépayé rechargé par carte dès 5 € HT, facture à chaque recharge, débit à l’usage, quotas gratuits mensuels, paliers progressifs, erreur 402 et en-tête X-Vitef-Balance.

Versions et changements

Ce qui change dans l’API /v1, daté : nouveautés, garanties de compatibilité, champs et valeurs inconnus à tolérer, et calendrier de dépréciation d’une future version.

Référence complète

Toutes les routes, paramètres et schémas sont décrits dans la référence interactive, générée depuis le code de l’API, et dans le fichier OpenAPI 3.1 pour générer votre client. La version /v1 ne change jamais de façon incompatible.