Activer l’API Studio

Présentation

L’API Studio permet de gérer vos organisations par API (utilisateurs, ordinateurs, groupes, collections, plannings, expériences à distance) — voir Gérer les organisations pour la fonctionnalité côté organisation.

Avant qu’un administrateur d’organisation puisse activer et générer des clés d’API depuis les paramètres de son organisation, l’API Studio doit être activée au niveau de l’instance, via le rôle Ansible reemo-infra.

Contrairement à l’API interne, l’API Studio est exposée sur le host du portail existant (/api/studio-api) : elle ne nécessite pas de nom d’hôte dédié, de certificat mTLS ni de PKI séparée.

Référence des endpoints

Note

La référence complète des endpoints de l’API Studio (routes, schémas de requête/réponse) est disponible à l’adresse /api-docs/ de cette documentation.

Variables de configuration

STUDIOAPI_ENABLED

Active l’API Studio pour l’instance. Valeur booléenne (true / false). Par défaut : false.

STUDIOAPI_RESTRICT_IP

Liste des adresses ou plages IP autorisées à appeler l’API Studio, chacune identifiée par un nom. Laisser vide pour ne pas filtrer.

Note

Ces deux variables activent la fonctionnalité au niveau de l’instance uniquement. Chaque organisation doit ensuite être activée individuellement par un administrateur d’instance, puis générer ses propres clés d’API depuis ses paramètres — voir Gérer les organisations et Paramètres de l’organisation.

Exemple de configuration

Ce paramétrage s’applique soit dans un environnement portal_manager, soit dans un environnement infra_manager, selon votre topologie de déploiement.

infra_manager:  # ou portal_manager, selon votre topologie
  vars:
    STUDIOAPI_ENABLED: true
    STUDIOAPI_RESTRICT_IP:
      - name: site1
        ip: "1.1.1.1/32"
      - name: site2
        ip: "1.2.2.2/32"

Points d’attention

• Ce paramétrage se fait au moment du déploiement (rôle Ansible reemo-infra), pas depuis l’interface.

• Une fois l’API Studio activée pour l’instance, elle reste désactivée par défaut pour chaque organisation : voir la puce API Studio dans Gérer les organisations.