Aller au contenu

Services API

Introduction

Canopsis expose deux API, servies par deux services :

Service Préfixe Port par défaut Rôle
canopsis-internal-api /internal 8082 API interne, utilisée par l'interface web. Elle gère aussi les traitements périodiques de la plateforme.
canopsis-public-api /api/v5 8083 API publique, pour les scripts et intégrations

Les deux services doivent être démarrés. L'option -h affiche toutes les options disponibles au lancement de chaque service.

Options de démarrage de canopsis-internal-api

Option Description
-c string Répertoire des fichiers de configuration (défaut : "/opt/canopsis/share/config")
-cps.logger string Destination de sortie du logger. Remplace le paramètre "Canopsis.logger.Writer" du fichier de configuration TOML
-broadcastMessagePeriodicalWaitTime duration Durée entre deux vérifications des messages de diffusion (défaut : 1m0s)
-d Active le mode debug
-docs Active la documentation Swagger de l'API interne
-enableSameServiceNames Permet d'avoir des noms de service identiques, par défaut les services ont des noms uniques
-entityCategoryMetaPeriodicalWaitTime duration Durée d'attente entre deux exécutions du processus périodique pour mettre à jour les métadonnées de catégorie d'entité (défaut : 1m0s)
-externalDataAPITimeout duration Délai d'attente pour les requêtes HTTP vers l'API externe (défaut : 30s)
-instructionRateNotificationPeriodicalWaitTime duration Durée pour vérifier les instructions et créer des notifications de taux (défaut : 1h0m0s)
-integrationPeriodicalWaitTime duration Durée d'attente pour vérifier périodiquement les résultats des tâches des moteurs (défaut : 5s)
-logBody Active la journalisation des corps de requêtes et réponses
-logBodyOnError Active la journalisation des corps de requêtes et réponses en cas d'erreur
-periodicalWaitTime duration Durée d'attente entre deux exécutions du processus périodique (défaut : 1m0s)
-port int Port du serveur (défaut : 8082)
-secure Sécurise les sessions
-stateSettingRecomputeDelay duration Durée minimum d'attente avant d'envoyer un événement de recalcul pour les services et composants (défaut : 1s)
-version Affiche les informations de version

Options de démarrage de canopsis-public-api

Option Description
-c string Répertoire des fichiers de configuration (défaut : "/opt/canopsis/share/config")
-docs Active la documentation Swagger, disponible sur l'URL /api/v5/docs/swagger.yaml
-logBody Active la journalisation des corps de requêtes et réponses
-logBodyOnError Active la journalisation des corps de requêtes et réponses en cas d'erreur
-periodicalWaitTime duration Durée d'attente entre deux exécutions du processus périodique (défaut : 1m0s)
-port int Port du serveur (défaut : 8083)
-version Affiche les informations de version

Exemple d'utilisation

/opt/canopsis/bin/canopsis-public-api -port 8083 -docs

Cette commande lance l'API publique sur le port 8083, avec la documentation Swagger activée.