Afficher l’analyse de l’API

L’analyse des API permet une visibilité sur le trafic des API. Cette analyse permet aux administrateurs informatiques de surveiller les instances d’API et les points de terminaison servis par une passerelle API. Il fournit une surveillance périodique intégrée des demandes d’API.

Avant de surveiller l’analyse des API, assurez-vous d’effectuer les opérations suivantes :

1. Ajouter une définition d’API
2. Déployer une définition d’API
3. Ajouter une stratégie à une définition d’API
4. Appliquer une licence aux instances API
5. Activer Web Insight sur les instances API

Dans API Analytics, vous pouvez surveiller le temps de réponse des instances d’API et des points de terminaison ajoutés dans le cadre des définitions d’API. Il affiche également la bande passante consommée par les instances d’API et les points de terminaison.

Par défaut, le tableau de bord affiche les analyses d’API pour la dernière heure. Vous pouvez sélectionner une durée pour afficher les analyses d’API pour cet intervalle. Cliquez sur Voir plus sur chaque vignette pour afficher la liste entière. Dans cette vue, vous pouvez rechercher des instances d’API et des points de terminaison par leurs noms partiels, à l’exception de la vignette Emplacements géographiques.

Distribution des points de terminaison API

Ce graphique affiche la répartition du temps de réponse des applications et du serveur pour les points de terminaison API. Vous pouvez identifier un point de terminaison d’API dont le temps de réponse est énorme et prendre les mesures nécessaires.

Les points de terminaison de l’API apparaissent dans l’une des couleurs suivantes en fonction de leurs limites de temps de réponse :

• Vert : si le temps de réponse est inférieur à 30 millisecondes.
• Orange — Si le temps de réponse est compris entre 30 et 100 millisecondes.
• Rouge — Si le temps de réponse est supérieur à 100 millisecondes.

Instances API

La vignette Instances d’API affiche les principales instances d’API avec un temps de réponse élevé pour les applications et le serveur.

Sélectionnez une instance d’API pour afficher ses performances, son utilisation et ses détails de sécurité. L’instance d’API sélectionnée affiche les informations suivantes :

• Nombre de points de terminaison API
• Nombre de demandes
• Temps de réponse des applications et du serveur
• Bande passante consommée
• Échec de l’authentification

Points de terminaison d’API

La vignette API Endpoints affiche les points de terminaison supérieurs avec un temps de réponse élevé pour les applications et le serveur.

Sélectionnez un point de terminaison d’API pour afficher les détails sur les performances, l’utilisation et la sécurité.

Échec de l’authentification

La vignette Auth Failures affiche les principaux points de terminaison de l’API qui présentent plus d’échecs d’authentification. L’échec ou le succès de l’authentification se produit en fonction de la stratégie ajoutée à une définition d’API.

Si vous souhaitez afficher l’échec et le taux de réussite de l’authentification dans un point de terminaison API, procédez comme suit :

1. Sélectionnez un point de terminaison dans les points de terminaison API.

2. Sélectionnez l’onglet Sécurité. Cet onglet affiche les échecs et réussites d’authentification dans le point de terminaison sélectionné.

Si vous souhaitez afficher l’échec et le taux de réussite de l’authentification dans les points de terminaison API d’une instance, procédez comme suit :

1. Sélectionnez une instance dans l’ instance API.

2. Sélectionnez l’onglet Sécurité. Cet onglet affiche les échecs et réussites d’authentification dans les points de terminaison de l’instance sélectionnée.

Afficher différentes informations sur les API

Naviguez dans API Analytics pour afficher des informations spécifiques sur les éléments suivants :

• Points de terminaison d’API les plus importants dans une instance
• API les plus consultées
• Géo-localisation d’un point de terminaison
• Statut de la réponse HTTPS
• Tendance des requêtes API
• Consommation de bande passante d’un point de terminaison
• Erreurs SSL et utilisation

Afficher les principaux points de terminaison de l’API dans une instance

La page API Analytics affiche les points de terminaison les plus élevés ayant un temps de réponse élevé. Si vous souhaitez afficher des points de terminaison similaires d’une instance, sélectionnez une instance dans les instances API.

La vignette Top API Endpoints affiche les points de terminaison dont le temps de réponse des applications et du serveur est élevé.

Afficher les API les plus consultées

Dans API Analytics, sélectionnez une instance d’API à partir des instances d’API. La vignette API les plus consultées affiche les points de terminaison supérieurs qui ont plus de demandes et de bande passante.

Afficher la géolocalisation d’un point de terminaison

1. Dans API Analytics, sélectionnez l’une des options suivantes :

   • Sélectionnez une instance dans les instances API pour afficher les emplacements à partir desquels les points de terminaison de l’instance sélectionnée ont reçu des demandes.

   • Sélectionnez un point de terminaison dans les points de terminaison API pour afficher les emplacements à partir desquels le point de terminaison a reçu des demandes.

2. Dans Performances et utilisation, la vignette Emplacements géographiques apparaît.

   Vous pouvez trier les emplacements en fonction du temps de réponse, de la bande passante et des demandes.

Afficher l’état de la réponse HTTPS

La vignette État de la réponse HTTPS affiche l’état de la réponse avec ses raisons et ses occurrences. Vous pouvez afficher l’état de la réponse HTTPS de l’une des manières suivantes :

• Sélectionnez une instance dans les instances API.

• Sélectionnez un point de terminaison dans les points de terminaison API.

Cette vignette apparaît dans l’onglet Performances et utilisation.

Voir la tendance des demandes d’API

Sélectionnez un point de terminaison dans les points de terminaison API. Dans Performances et utilisation, la vignette Total des demandes affiche la tendance du nombre total de demandes reçues par un point de terminaison.

Si vous souhaitez afficher la tendance des demandes abandonnées en raison d’une limite de débit, sélectionnez une instance dans les instances API. Dans Sécurité, la vignette Limite de débit affiche la tendance des demandes abandonnées. Il affiche également la tendance du nombre total de demandes reçues par un point de terminaison.

Avec cette comparaison, vous pouvez déterminer le nombre de demandes supprimées en raison d’une limite de taux entre le nombre total de demandes.

Afficher la consommation de bande passante d’un point de terminaison

Pour afficher la tendance de la consommation de bande passante par un point de terminaison, sélectionnez un point de terminaison dans les points de terminaison de l’API. La vignette Bande passante affiche un graphique de consommation de bande passante.

Afficher les erreurs SSL et l’utilisation

Sélectionnez une instance dans les instances API. Dans Sécurité, les vignettes suivantes apparaissent :

• Erreurs SSL — Affiche les échecs SSL survenus sur les clients et les serveurs d’applications.

• Utilisation de SSL  : affiche les certificats SSL, les protocoles, le chiffrement et les points forts clés avec leurs occurrences.

Pour afficher l’utilisation de SSL dans un point de terminaison, sélectionnez un point de terminaison dans les points de terminaison de l’API. La vignette Utilisation de SSL apparaît dans l’onglet Sécurité.