Stratégie de versioning

Comprenez comment le versioning apparaît dans les endpoints et les types d'événements OmniLab, et comment vous préparer aux évolutions.

1 min de lecture

OmniLab expose des marqueurs de version directement dans les chemins d'endpoint et les noms d'événements, comme /v1/oauth:token, /v1/interactions:fetchContactBookings, et les types d'événements webhook qui se terminent par .v1.

Ce qui est versionné

  • Les endpoints REST sous /v1/...
  • Les types d'événements webhook, comme reward.won.v1 et booking.created.v1
  • Les schémas de payload associés à ces versions

Règles pratiques de compatibilité

  • Traitez les nouveaux champs facultatifs comme des ajouts, pas comme des ruptures.
  • Traitez comme des ruptures les changements de chemin, les changements de champs obligatoires et les renommages de types d'événements.
  • Faites reposer la logique de votre récepteur sur les noms d'événements exacts auxquels vous êtes abonné aujourd'hui.
  • Gardez en staging des tests de contrat pour les demandes de jeton, les flux de réservation et les signatures des webhooks.
  • Validez le parsing en aval avant de faire passer un changement en production.

Comment se préparer aux évolutions

  1. Gardez la logique de votre intégration OmniLab derrière une petite couche d'adaptation.
  2. Conservez des exemples de payloads de requête et de réponse issus du staging.
  3. Testez à nouveau les flux de réservation et la vérification des signatures des webhooks à chaque changement annoncé.
  4. Faites passer les changements par le staging avant de les mettre en production.

Étapes suivantes

Sur cette page