Skip to main content

Documentation et accès API Rest

Documentation

OIConnect dispose d’une API REST permettant de gérer une grande partie de l’infrastructure réseau de l’OI. Une documentation en ligne est disponible directement depuis le menu principal.

Pour accéder à cette documentation, cliquez sur l’icône suivante :
Icône Documentation

Vous serez redirigé vers une page détaillant les endpoints et les méthodes disponibles :
Page Documentation API

Liste des clés API

L’utilisation de l’API REST est contrôlée par un système de clés d’authentification. Cela permet de sécuriser l’accès et de révoquer des autorisations en fonction des logiciels ou programmes connectés.

À savoir : Les droits d’accès nécessaires pour cette fonctionnalité sont "API | Administrateur".

Gestion des clés API

Pour accéder à la liste et gérer les clés API, cliquez sur l’icône suivante dans le menu :
Icône Clés API

Vous serez redirigé vers la page suivante :
Page Clés API

Outils de filtrage

Les clés peuvent être filtrées selon les critères suivants :

  • Nom (name)
  • Date de création (created)
  • Date d’expiration (Expires)
  • Révoqué (revoked)

Gestion des clés

Vous pouvez effectuer les actions suivantes :

  • Créer une nouvelle clé : Remplissez les champs nécessaires, comme le nom de la clé, et définissez une date d’expiration si nécessaire.
    Création de clé API

    Attention : Une fois la clé générée, vous devez la conserver car elle ne pourra pas être retrouvée ultérieurement.

  • Modifier une clé existante : Ajustez ses paramètres ou demandez une révocation.

  • Révoquer une clé : Une clé révoquée ne peut pas être réactivée.

  • Supprimer une clé : À utiliser avec prudence. La révocation ou l’ajout d’une date d’expiration est préférable.

Gestion des clés API

API Interop

OIConnect offre également une interface dédiée pour l’API INTEROP, permettant de gérer les interactions selon les spécifications du protocole INTEROP’FIBRE.

Pour accéder à cette fonctionnalité, cliquez sur l’icône suivante :
Icône API INTEROP

Vous serez redirigé vers la page suivante :
Page API INTEROP

Outils de filtrage

L’interface permet de trier les API INTEROP selon :

  • Nom
  • Type
  • Accès

Ces outils simplifient la gestion et le contrôle des connexions API au sein de l’écosystème INTEROP.

Back to top