Accéder à la page des détails de l’API et l’utiliser

Pour accéder à la page des détails de l’API, accédez à Espaces de travail > Aperçus des API, sélectionnez l’onglet API , puis sélectionnez une API dans la colonne Nom de la table API.

Affichage des données

Par défaut, la page affiche les données suivantes :

• Région de l’en-tête
• Région des métadonnées
• Listes connexes
• Panneau de vue d’ensemble
• Utilisation
• Sécurité
• Events
• Carte des relations

Région de l’en-tête

Affiche le nom de l’API, les informations de version, l’étape actuelle du cycle de vie de l’API, par exemple, Opérationnel ou Fin de vie.

La liste Afficher par vous permet de basculer entre les différentes plateformes de gestion, le cas échéant, sous lesquelles l’API est gérée.

Le sélecteur de version permet de sélectionner différentes versions de l’API à afficher et à gérer. Sélectionnez Mettre à jour pour mettre à jour les détails en fonction de la version sélectionnée.

Remarque :

La liste Afficher par et le sélecteur de version s’affichent uniquement s’ils s’appliquent à une API.

Région des métadonnées

Affiche les champs suivants.

Champ	Description
Description	Bref résumé ou objectif de l’API.
Dernière détection	Dernière date de détection ou de mise à jour de l’API dans le CMDB.
Source de découverte	Source à partir de laquelle l’API a été détectée.
Type	Type d’API, qu’il s’agisse d’API REST scriptée, d’API HTTP, d’API REST de plateforme, entre autres.
Groupe de propriété	Équipe ou groupe responsable de la gestion de l’API.
Interface digitale	Méthode d’interaction de l’API dans le système.

Listes connexes

Affiche les champs suivants.

Champ	Description
Demandes d’accès reçues	Affiche le nombre de demandes d’accès effectuées pour l’API. Sélectionnez le numéro affiché sur la carte pour afficher les détails de la demande d’accès.
Consommateurs	Affiche le nombre de consommateurs de l’API.
Déploiements	Indique tout déploiement actif ou passé de l’API dans les environnements.

Panneau de vue d’ensemble

Répertorie toutes les opérations disponibles (points de terminaison) de l’API. Sélectionnez un point de terminaison pour en afficher les détails.

Utilisation

Affiche les champs suivants.

Champ	Description
Demandes quotidiennes	Nombre de demandes de composants d’API au fil du temps, représentées sous la forme d’un graphique linéaire, avec l’axe X affichant la plage de dates et l’axe Y affichant le nombre de demandes.
Demandes par version (10 derniers jours)	Répartition des demandes d’API entre différentes versions au cours des 10 derniers jours.
Applications de gestion	Nombre de contextes d’entreprise également appelés en tant qu’application d’entreprise liée à la conception de l’API, tels qu’ils sont reflétés dans l’enregistrement d’interface digitale.

Sécurité

Affiche les champs suivants.

Champ	Description
Éléments de vulnérabilité actifs	Vulnérabilités de sécurité associées à l’activation de l’API permettant de suivre et de résoudre les risques potentiels.
Incidents de sécurité	Les incidents de sécurité, s’ils sont activés, fournissent des informations sur les violations de sécurité ou les problèmes qui ont pu se produire avec l’API.

Événements

Affiche les champs suivants.

Champ	Description
Alertes critiques	Alertes critiques des opérations informatiques liées à l’API, permettant d’identifier les problèmes majeurs susceptibles d’affecter les performances de l’API.
Incidents	Incidents enregistrés, tels que des pannes, des demandes de changement ou des problèmes liés à l’API, essentiels pour suivre l’intégrité opérationnelle et les efforts de rattrapage.

Carte des relations

Fournit une vue d’ensemble hiérarchique des relations de l’API avec ses composants, ses plateformes de gestion , ses applications d’entreprise et ses conceptions, ce qui facilite la compréhension du rôle de l’API dans l’architecture système plus large. En outre, il offre la possibilité de gérer les relations de service d’application. Reportez-vous à Gestion des relations de service d’application pour les API.

Une carte des relations est une carte unifiée partielle similaire à celle utilisée dans le Espace de travail CMDB. Pour ouvrir la carte unifiée des API, sélectionnez Ouvrir la carte complète dans la section Carte des relations de la page des détails de l’API. Pour en savoir plus, consultez Carte unifiée.

Les nœuds sur la carte représentent l’API et ses composants dans la ligne et représentent les connexions et les relations entre les composants de l’API CMDB . Les connexions vous aident, par exemple, à évaluer l’impact d’une modification sur un nœud sélectionné en affichant les composants qui y sont connectés par le biais de relations et de références. Produits tels que Change Management, Incident Managementet Event Management bénéficient de ces informations.

La carte montre également la composition des services d’application, utiles avec des produits tels que Event Management et Incident Management. Vous pouvez consulter les changements historiques.

Les éléments suivants sont disponibles dans la carte unifiée des API :

1 : Carte

La carte affiche l’API spécifiée et ses connexions et relations. Dans l’exemple, httpbin.org-v1.1 est le nœud d’accueil et les lignes représentent les connexions et les relations avec d’autres composants. Sélectionnez n’importe quel nœud pour afficher des détails tels que les services d’application connexes, l’historique des changements.

2 : Contrôles de contenu

• Recherchez et sélectionnez le nœud d’accueil, spécifiez le nombre de niveaux de relation que les services d’application doivent afficher et rechargez la carte une fois les modifications apportées.
• Utilisez des filtres pour limiter les types et les types de relations qui apparaissent sur la carte.
• Afficher ou masquer la chronologie des événements (éléments connexes) pour l’API sélectionnée

3 : Boîte à outils

Utilisez la boîte à outils pour contrôler plusieurs aspects visuels de la carte, tels que le niveau de zoom ou le mode de mise en page.

4 : Panneau latéral contextuel

• Le panneau Attributs ( répertorie des attributs tels que l’emplacement et l’état opérationnel de l’API ou de la relation sélectionnée.
• Le panneau Services d’application ( répertorie les détails des services d’application associés à l’API sélectionnée.
• Le panneau Éléments connexes ( affiche les éléments connexes tels que les incidents actifs ou les problèmes actifs pour l’API sélectionnée.
• Le panneau Modifications (icône répertorie les changements tels que les changements apportés à l’état opérationnel de l’API sélectionnée.

5 : Navigateur de mini-carte

Réglez le niveau de zoom ou déplacez la vue vers une zone d’intérêt. Sélectionnez l’icône pour afficher ou masquer le navigateur.

6 : Échéancier

La chronologie indique les événements (éléments connexes) tels que les incidents, les problèmes et les changements pour l’API sélectionnée sur une période donnée. Vous pouvez utiliser la chronologie pour visualiser l’historique des modifications apportées à une API et la façon dont elles affectent la topologie de l' CMDB.