API
Documentation
OIConnect dispose d’une API REST qui permet de gérer une grande partie de l’infrastructure réseau de l’OI. Une documentation en ligne de l’API est directement disponible depuis le menu principal.
L'icône Documentation :
En Cliquant sur cette icône vous serez redirigé sur cette page :
Liste des clés API
L’utilisation de l’API est contrôlée par la génération de clés. Cette approche permet de révoquer des accès à l’API en fonction du logiciel ou du programme connecté à celle-ci.
À savoir : Les droits d’accès nécessaires pour accéder à cette fonctionnalité sont "API | administrateur ".
L'Icône clés :
En Cliquant sur cette icône vous serez redirigé sur cette page :
Vous avez la possibilité de filtrer les Clés de par la première ligne, mais aussi la deuxième qui augmente la précisoin de votre recherche.
Filtrer en fonction de :
- Nom (name)
- Date de création (created)
- Date d'expiration (Expires)
- Révoqué (revoked)
Il vous est donné la possibilité de supprimer, modifier mais aussi ajouter ces derniers.
Lors de la création d’une nouvelle clé d’authentification API, vous devez impérativement indiquer le nom de clé. Il vous est ensuite possible de déterminer une date d’expiration si nécessaire.
Attention : Une fois la demande de création envoyée, un message vous indiquera la clé API à conserver. Cette clé ne pourra pas être retrouvée une fois générée.
Vous pouvez à tout moment supprimer une clé. Il est toutefois préférable del’éditer puis de demander sa révocation ou d’ajouter une date d’expiration.
Attention : Les clés révoquées ne peuvent pas être remises en service.
API Interop
L'Icône API INTEROP :
En Cliquant sur cette icône vous serez redirigé sur cette page :
Triez en fonction de :
- Nom
- Type
- Accès