Guide de développement Canopsis¶
Vous trouverez ici toute la documentation nécessaire au développement autour de Canopsis.
Documentation des API¶
Canopsis expose deux API REST (voir une définition) :
- l'API publique (
/api/v5), versionnée et stable, à utiliser pour tous les scripts, connecteurs et intégrations ; - l'API interne (
/internal), réservée à l'interface web de Canopsis. Elle peut changer à chaque version : ne l'utilisez pas dans vos scripts.
La page API publique décrit les URL, l'authentification par jeton, les conventions, les routes disponibles et la migration des scripts qui utilisent encore /api/v4.
La spécification détaillée de l'API publique est disponible dans Swagger-community et Swagger-pro. Elle suit l'OpenAPI Specification 3.0.
Redirections HTTP
Les API REST imposent aux clients de respecter la spécification HTTP, et notamment de prendre en charge toute redirection HTTP envoyée par l'API.
Certains clients HTTP, comme curl, ne suivent pas les redirections par défaut. Utilisez curl -L en ligne de commande (ou l'option CURLOPT_FOLLOWLOCATION de la bibliothèque) pour vous interfacer correctement avec les API REST.