Versionnement

La version majeure de l’API est dans le chemin : https://aicscan.io/v1/…. Chaque réponse de /v1 porte aussi l’en-tête :

HTTP

Aicscan-Api-Version: 1

Ce qui peut changer dans v1#

v1 ne reçoit que des ajouts compatibles :

nouveaux points d’accès ;
nouveaux champs dans les réponses ;
nouveaux paramètres facultatifs ;
nouveaux codes d’erreur, nouvelles valeurs d’énumération (types de règles, types d’événements, étapes de notification) ;
amélioration du texte des messages d’erreur (error.message).

Votre intégration doit donc ignorer les champs inconnus, traiter une valeur d’énumération inconnue sans planter, et se fonder sur error.code plutôt que sur error.message.

Ce qui ne changera pas dans v1#

Le nom, le type et le sens d’un champ existant.
Les codes d’erreur existants et leur statut HTTP.
Le format de la signature des webhooks et du flux temps réel.

Un changement incompatible ouvrira une nouvelle version (/v2), publiée à côté de v1 et annoncée dans le journal des modifications.

Document OpenAPI#

Le contrat de v1 est décrit par un document OpenAPI 3.1, servi par l’API elle-même et toujours aligné sur la version en service :

Shell

curl -o aicscan-openapi.yaml https://aicscan.io/v1/openapi.yaml