Vue d'ensemble de l'API
L'API Veridien est une interface REST vers les données de votre établissement : disponibilités et tarifs, clients et fidélité, réservations et notes. C'est le moteur qui fait tourner les parcours de réservation de Veridien lui-même, exposé pour que vous puissiez construire par-dessus un moteur de réservation sur mesure, une application mobile pour vos clients, une intégration de fidélité ou n'importe quelle automatisation de back-office.
C'est une API HTTP/JSON ordinaire. Vous vous authentifiez avec une clé d'API, vous envoyez et recevez du JSON, et vous vous appuyez sur les codes de statut standard. Tout est limité à un seul établissement : une clé ne peut jamais lire ni modifier autre chose que les données de l'établissement auquel elle appartient.
Conçue pour de vraies applications
Cette API pilote de bout en bout le parcours de réservation et de fidélité en production des établissements Veridien : rechercher les disponibilités, bloquer une chambre, enregistrer un client, confirmer une réservation avec un paiement, passer des frais sur une note, cumuler ou utiliser des points de fidélité. Suivez le Démarrage rapide pour dérouler vous-même tout ce parcours.
Toutes les requêtes passent par une seule URL de base versionnée :
https://veridien.app/api/v1Chaque chemin de cette référence est relatif à cette base. Le contrôle de santé, par exemple, est https://veridien.app/api/v1/health.
Les requêtes s'authentifient avec une clé d'API bearer dans l'en-tête Authorization :
Authorization: Bearer vrdn_live_xxxxxxxxxxxxxxxxxxxxChaque clé est liée à un établissement et porte un jeu de portées qui décide des endpoints qu'elle peut appeler. Créez et gérez les clés dans le tableau de bord, sous Paramètres → Clés d'API. Les endpoints méta publics (/health, /openapi.json) n'ont besoin d'aucune clé ; tout le reste en exige une.
Voyez Authentification pour le format des clés, la liste complète des portées et un exemple qui fonctionne.
- Du JSON en entrée, du JSON en sortie. Envoyez
Content-Type: application/jsonsur les requêtes qui ont un corps. Les noms de champs sont ensnake_case(room_type_id,check_in_date). - L'argent est en chaînes de caractères. Les montants sont des chaînes décimales à deux décimales (
"249.00") pour éviter les arrondis en virgule flottante. La devise est un code ISO à 3 lettres. - Les dates sont en chaînes de caractères. Les dates du calendrier s'écrivent
YYYY-MM-DD. Les horodatages sont en ISO 8601 (2026-06-19T08:30:00.000Z). - Les erreurs sont uniformes. Chaque échec renvoie la même enveloppe
error, avec uncodelisible par une machine et unrequest_id. - Les nouvelles tentatives sont sûres. Les requêtes qui modifient des données acceptent un
Idempotency-Key, de sorte qu'une nouvelle tentative ne facture ni ne réserve jamais deux fois.
Les règles complètes vivent dans Conventions.
| Domaine | Endpoints |
|---|---|
| Catalogue | Détails de l'établissement, types de chambres, disponibilités et tarifs soumis à des règles de visibilité. Voyez Établissement et catalogue. |
| Offres | Lister les tarifs et forfaits publics, et valider un code promotionnel avant de l'annoncer. Voyez Offres et codes promo. |
| Clients | Enregistrer ou rattacher un client, lire et mettre à jour les fiches, lire la fidélité, utiliser des points. Voyez Clients et fidélité. |
| Réservations | Bloquer des disponibilités, transformer un blocage en réservation payée, lister et lire des réservations, annuler. Voyez Réservations. |
| Notes | Lire la note d'une réservation et y passer des frais. Voyez Notes. |
L'API est versionnée dans le chemin (/api/v1). Les changements incompatibles avec l'existant sortent sous une nouvelle version ; les changements additifs (nouveaux endpoints, nouveaux champs facultatifs) se font à l'intérieur de v1. Traitez les champs de réponse inconnus comme des ajouts et ignorez-les plutôt que d'échouer.
Une description OpenAPI 3.1 de chaque endpoint, lisible par une machine, est servie sans authentification à l'adresse :
GET https://veridien.app/api/v1/openapi.jsonServez-vous-en pour générer des clients typés ou pour vérifier exactement quels endpoints et quelles structures sont déployés. C'est la source de vérité, et elle correspond toujours à l'API en fonctionnement.