Découvrir les points de terminaison API

Vous pouvez afficher les points de terminaison d’API découverts qui se trouvent dans votre organisation via la solution API Security. La console NetScaler découvre les points de terminaison de l’API en fonction du trafic d’API reçu sur les instances NetScaler et les déploiements d’API.

Dans la console NetScaler, la page Sécurité > Sécurité des API > Découverte des API affiche les points de terminaison d’API découverts.

• Serveursvirtuels : l’onglet vServer affiche les serveurs virtuels de vos instances NetScaler. Les serveurs virtuels apparaissent dans cet onglet lorsqu’ils reçoivent les demandes d’API pour la période spécifiée.

• Déploiements d’API : cet onglet affiche les déploiements d’API déployés depuis la console NetScaler à l’aide d’une définition d’API. Cet onglet découvre les points de terminaison de l’API lorsque les déploiements d’API reçoivent les demandes d’API pour la période spécifiée. Pour ajouter et déployer une définition d’API, voir Ajouter une définition d’API et Déployer des définitions d’API.

Remarque :

• Assurez-vous de configurer les analyses et d’activer Web Insights sur les serveurs virtuels. Voir Activer Web Insight sur les instances d’API.

• Vous pouvez uniquement ajouter des stratégies aux points de terminaison de l’API découverts sous l’onglet Déploiements d’API.

Afficher les points de terminaison API

Dans API Discovery , lorsque vous sélectionnez un serveur virtuel ou un déploiement d’API, l’interface graphique de la console NetScaler affiche les points de terminaison de l’API et leurs informations, telles que :

• Méthode - Il affiche la méthode utilisée dans un point de terminaison API. Par exemple, méthodes GET et POST.

• Total requêtes - Il affiche le nombre de demandes d’API sur le point de terminaison de l’API.

• Status de réponse - Il affiche le nombre pour chaque état de réponse. Par exemple, 2xx, 3xx, 4xx, et 5xx.

• Found in Spec - Cette colonne apparaît uniquement pour les déploiements d’API. Parfois, les API internes qui ne font pas partie de la définition de l’API peuvent recevoir du trafic provenant de l’extérieur. Cette colonne vous permet d’identifier si le point de terminaison de l’API et la méthode observée font partie de la définition de l’API.

Les points de terminaison d’API d’un serveur virtuel sont disponibles comme suit :

Les points de terminaison de l’API dans les déploiements d’API sont disponibles comme suit :

Vous pouvez également sélectionner le point de terminaison API requis pour afficher son rapport d’analyse détaillé.

Pour plus d’informations sur chaque section, voir Afficher les analyses des API.

Création de définitions d’API à partir de points de terminaison d’API découverts

Pour créer des définitions d’API à partir des points de terminaison d’API découverts (ressources et méthodes d’API) :

1. Accédez à Sécurité > Sécurité des API > Découverte des API pour afficher la liste des serveurs virtuels et des déploiements d’API.

2. Cliquez sur n’importe quel serveur virtuel dans l’onglet vServers .

3. La page du serveur virtuel affiche la liste des points de terminaison découverts. Sélectionnez n’importe quel point de terminaison et cliquez sur Créer une définition d’API.

Remarque :

Si vous ne sélectionnez aucun point de terminaison et que vous cliquez sur Créer une définition d’API, une fenêtre contextuelle s’affiche pour vous permettre de confirmer si vous souhaitez créer une définition d’API pour tous les points de terminaison. Cliquez sur Oui pour créer la définition de l’API avec tous les points de terminaison, sinon cliquez sur Non.

1. Dans Créer une définition d’API, spécifiez les éléments suivants :

   • Nom  : nom de la définition de l’API.

   • Définition de l’API - Une définition doit inclure le titre, la version, le chemin de base et l’hôte. Vous pouvez spécifier un nom de domaine ou une adresse IP dans le champ Hôte.

   • API Resources - Ajoutez plusieurs ressources API à votre définition. Chaque ressource a un chemin d’accès et une méthode prise en charge.

2. Cliquez sur Créer une définition pour créer la définition de l’API.

Remarque :

Si vous souhaitez modifier le chemin d’une ressource d’API avant de l’ajouter à la définition de l’API, utilisez la fonctionnalité de tri ou de recherche des ressources d’API sur l’écran de définition de l’API.

Prenons l’exemple d’une ressource d’API nommée « /api/products/123-3243-2344334/reviews » où le segment de chemin « 123-3243-2344334 » est un identifiant de produit variable. Vous pouvez désormais trier les ressources de l’API, ajouter le chemin de la ressource sous la forme « /api/products/ {id} /reviews » et supprimer tous les points de terminaison de l’API avec des identifiants tels que « /api/products/123-3243-2344334/reviews ».

Mettre à jour une définition d’API existante avec les points de terminaison d’API découverts

Pour mettre à jour une définition d’API existante avec des points de terminaison d’API (ressources et méthodes d’API) :

1. Accédez à Sécurité > Sécurité des API > Découverte des API pour afficher la liste des serveurs virtuels et des déploiements d’API.

2. Cliquez sur n’importe quel serveur virtuel dans l’onglet vServers .

3. La page du serveur virtuel affiche la liste des points de terminaison découverts. Sélectionnez le point de terminaison que vous souhaitez ajouter à une définition d’API existante. Cliquez sur Mettre à jour la définition d’API existante.

   

4. Dans la liste déroulante Sélectionner une définition d’API existante, sélectionnez la définition d’API que vous souhaitez mettre à jour. Cliquez sur Mettre à jour la définition.

5. La page Mettre à jour la définition d’API existante s’affiche. La section Ressources API affiche les tableaux suivants :

   • Ressources ajoutées : les points de terminaison de l’API que vous avez sélectionnés

   • Ressources existantes : les points de terminaison de l’API déjà disponibles dans la définition de l’API

   Remarque :

   Si le même point de terminaison d’API est disponible dans Ressources ajoutées et Ressourcesexistantes, le point de terminaison n’est ajouté qu’une seule fois à la définition de l’API.

6. Cliquez sur Mettre à jour la définition.