Versions et évolutions
Ce qui peut changer dans la version 1 de l’API sans vous prévenir, et ce qui ne changera pas.
La version fait partie du chemin : https://api.nessflow.com/v1/….
Ce qui peut arriver dans la v1
Des changements additifs, sans nouvelle version :
- de nouvelles opérations, de nouveaux champs dans une réponse, de nouveaux paramètres facultatifs ;
- de nouvelles valeurs dans une liste ouverte : un nouveau type d’événement de webhook, un nouveau code d’erreur, un nouveau
statusde rapport.
Votre intégration doit donc ignorer les champs inconnus et traiter une valeur inconnue comme un cas à part, sans planter.
Ce qui ne change pas dans la v1
Un champ existant ne change ni de nom, ni de type, ni de sens ; un code d’erreur garde son sens ; une opération garde son chemin. Un changement incompatible passerait par une nouvelle version, annoncée dans le journal des modifications de l’API.
Vérifier contre la spécification
La spécification OpenAPI 3.1 est publiée avec cette documentation, et les tests de NessFlow valident chaque réponse contre elle. Générer un client depuis elle est la façon la plus sûre de rester aligné.