API 💡

L’API Canopsis permet d’interagir en lecture et en écriture avec la plateforme. En effet, elle offre un ensemble de points d’entrée permettant aux utilisateurs, outils tiers et scripts :

• d’automatiser des tâches,
• d’intégrer des données,
• ou d’extraire des informations.

Voici par exemple quelques-unes de ses possibilités :

• Publication d’événements
• Mise en maintenance
• Import de référentiels
• Création de tickets d’incidents
• …

  Mise à jour 2021 : Réécriture des API

Pour commencer, réécrire les API en Go (initialement en Python) améliore les performances et les temps d’exécution des appels, tout en facilitant leur maintenance et leur sécurité.

Cela s’accompagne aussi d’une auto-documentation conforme à OpenAPI, permettant de générer automatiquement des informations fiables et à jour sur les API disponibles.

Les accès peuvent désormais être sécurisés de manière très fine, au niveau de chaque API et de chaque opération, renforçant la maîtrise des flux et la protection du système d’information.

  Mise à jour 2025 : Introduction des changelogs et breaking changes

L’API Canopsis intègre dorénavant des changements que vous devez prendre en compte :

• Changelog
• Breaking changes

  Mise à jour 2026 : Séparation de l’API publique et privée

L’API Canopsis sera désormais divisée en deux périmètres distincts.

• Pour les clients :

L’API publique sera versionnée dès la version 26.10 : /api/v5. Elle garantit la stabilité de vos scripts et intégrations dans le temps. La sécurité est renforcée avec l’introduction progressive d’une authentification moderne (JWT), en remplacement du Basic Auth.

De plus, la nouvelle documentation de rétrocompatibilité et l’ACL distingueront clairement les endpoints publics et internes.

• Pour les équipes de développement :

L’API privée – /api/internal – évoluera librement, sans contrainte de rétrocompatibilité, pour accélérer les évolutions de l’interface et les optimisations internes.

Pour plus d’informations techniques sur l’API et toutes les autres fonctionnalités, nous vous invitons à vous rendre sur notre documentation. Vous pouvez également échanger avec notre équipe via le formulaire de contact.