La version majeure figure dans le chemin : /v1. Une intégration écrite pour /v1 continue de fonctionner, sans changement, tant que /v1 existe.
Ce qui peut changer dans /v1
- Nouvelles opérations, nouveaux scopes.
- Nouveaux paramètres facultatifs, nouveaux champs dans les réponses.
- Nouvelles valeurs d'énumération (un statut, un type de véhicule, une enseigne), nouveaux codes d'erreur pour de nouveaux cas.
Ce qui ne change jamais dans /v1
- Une opération, un champ ou un scope ne disparaît pas, ne change ni de nom ni de type.
- Un paramètre facultatif ne devient pas obligatoire ; une validation ne se durcit pas.
- Un code d'erreur garde son sens ; une unité (millièmes d'euro, centimes) ne change pas.
L'en-tête Floweet-Version
Chaque réponse porte Floweet-Version, la version du contrat qui l'a servie (aujourd'hui 1.0.0-beta.1). Citez-la avec X-Request-Id si vous nous signalez un comportement inattendu.
Une rupture : /v2
Si une rupture devient nécessaire, elle arrive dans une nouvelle version, /v2, et /v1 continue de fonctionner au moins 12 mois après. Une opération dont le retrait est programmé sera marquée deprecated dans le contrat, et les organisations qui l'appellent encore seront prévenues par e-mail.
Pendant la bêta
L'API est en bêta (contrat 1.0.0-beta.1) : le contrat 1.0.0 sera figé avant l'ouverture de la première clé live, et la règle de compatibilité ci-dessus s'appliquera dès lors. D'ici là, tout changement est daté dans le journal des changements.