API

Documentation

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

L'Pour accéder à cette documentation, cliquez sur l’icône Documentationsuivante :

En Cliquant sur cette icône vousVous serez redirigé survers cetteune page détaillant les endpoints et les méthodes disponibles :

---

Liste des clés API

L’utilisation de l’API REST est contrôlée par laun générationsystème de clés.s Cetted’authentification. approcheCela permet de sécuriser l’accès et de révoquer des accès à l’APIautorisations en fonction dudes logiciellogiciels ou du programmeprogrammes connecté à celle-ci.s.

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

L'Icône

---

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 :

En Cliquant sur cette icône vousVous serez redirigé survers cettela page suivante :

---

Vous avez la possibilité

Outils de filtrerfiltrage

Les clés peuvent être filtrées selon les Cléscritères de par la première ligne, mais aussi la deuxième qui augmente la précisoin de votre recherche.

Filtrer en fonction desuivants :

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

---

Gestion des clés

IlVous vouspouvez esteffectuer donnéles laactions possibilitésuivantes de supprimer, modifier mais aussi ajouter ces derniers.:

• 

  Créer

  

  Lors de la création d’une nouvelle clé d’authentification: API,Remplissez vousles devezchamps impérativementnécessaires, indiquercomme le nom de la clé., Il vous est ensuite possible deet déterminerfinissez une date d’expiration si nécessaire.

  
  

  

  Attention : Une fois la demandeclé de création envoyégénérée, un message vous indiqueradevez la cléconserver APIcar à conserver. Cette cléelle ne pourra pas être retrouvée une fois générée.ultérieurement.

• Vous pouvez à tout moment supprimerModifier une clé. Ilexistante est: toutefoisAjustez préférableses del’éditerparamètres puisou dedemandez demanderune saré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’ajouter une date d’expiration.expiration est préférable.

Attention

: Les clés révoquées ne peuvent pas être remises en service.

---

API Interop

L'Icô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 :

Vous serez redirigé vers la page suivante :

---

Outils de filtrage

L’interface permet de trier les API INTEROP :

En Cliquant sur cette icône vous serez redirigé sur cette page :

Triez en fonction deselon :

• Nom
• Type
• Accès

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