Personnaliser votre portail du Centre d’API

Cet article explique les paramètres que vous pouvez personnaliser dans le portail du Centre des API (préversion). Le portail du Centre d’API est un site web géré par Azure que les développeurs et d’autres parties prenantes de votre organisation utilisent pour découvrir les API de votre centre d’API.

Pour configurer le portail du Centre d’API pour une utilisation initiale et une connexion, consultez Configurer le portail du Centre d’API.

Page paramètres du portail

Configurez les paramètres du portail du Centre des API dans le portail Azure. Pour accéder à la page des paramètres :

1. Accédez à votre centre d’API dans le Portail Azure.
2. Sous le portail du Centre des API, sélectionnez Paramètres.
3. Cliquez sur les onglets pour afficher et personnaliser les paramètres.
4. Sélectionnez Enregistrer + publier pour appliquer vos modifications.

Profil du site

Sous l’onglet Profil du site , indiquez éventuellement un nom personnalisé qui apparaît dans la barre supérieure du portail publié.

Visibilité de l’API

Sous l’onglet Visibilité de l’API , contrôlez les API détectables (visibles) par les utilisateurs du portail du Centre des API. Les paramètres de visibilité s’appliquent à tous les utilisateurs du portail du Centre d’API.

Le portail du Centre d’API utilise l’API du plan de données Azure API Center pour récupérer et afficher des API dans votre centre d’API, et affiche par défaut toutes les API pour les utilisateurs connectés disposant d’autorisations RBAC Azure.

Pour rendre visibles uniquement des API spécifiques, ajoutez des conditions de filtre pour les API en fonction des propriétés intégrées. Par exemple, choisissez d’afficher uniquement les API de certains types (comme REST ou GraphQL) ou en fonction de certains formats de spécification (comme OpenAPI).

Accès anonyme

Sous l’onglet Visibilité de l’API , activez éventuellement l’accès en lecture anonyme à l’API du plan de données Du Centre des API Azure, ce qui permet aux utilisateurs non authentifiés de découvrir l’inventaire des API par des appels d’API directs. Par exemple, activez ce paramètre pour rendre les API détectables pour les utilisateurs non authentifiés lorsque vous hébergez automatiquement le portail du Centre d’API.

Recherche sémantique

Si cette option est activée sous l’onglet Recherche sémantique, le portail du Centre des API complète la recherche d’API par noms avec une recherche sémantique assistée par l’IA, construite sur les noms d’API, les descriptions et, éventuellement, les métadonnées personnalisées. La recherche sémantique est disponible uniquement dans le plan Standard .

Les utilisateurs peuvent rechercher des API à l’aide de requêtes en langage naturel, ce qui facilite la recherche d’API en fonction de leur intention. Par exemple, si un développeur recherche « J’ai besoin d’une API pour la gestion des stocks », le portail peut suggérer des API pertinentes, même si les noms d’API ou les descriptions n’incluent pas ces mots exacts.

Pour utiliser la recherche assistée par l’IA quand vous êtes connecté au portail du Centre d’API, cliquez dans la zone de recherche, sélectionnez Rechercher avec IA et entrez une requête.

Métadonnées personnalisées

Sous l’onglet Métadonnées , sélectionnez éventuellement les propriétés de métadonnées personnalisées que vous souhaitez exposer dans les détails de l’API et la recherche sémantique.

Activer l’accès à la console de test pour les API

Vous pouvez configurer les paramètres utilisateur pour autoriser l’accès granulaire aux API et à leurs versions spécifiques dans votre centre d’API. Par exemple, configurez certaines versions d’API pour utiliser des clés API pour l’authentification et créez une stratégie d’accès qui permet uniquement aux utilisateurs spécifiques de s’authentifier à l’aide de ces clés.

Les stratégies d’accès s’appliquent également à la fonctionnalité « Essayer cette API » pour les API dans le portail du Centre des API, ce qui garantit que seuls les utilisateurs du portail disposant de la stratégie d’accès appropriée peuvent utiliser la console de test pour ces versions d’API. En savoir plus sur l’autorisation de l’accès aux API

Contenu connexe

• Configurer le portail du Centre d’API
• Activer et afficher le portail du Centre des API Azure dans Visual Studio Code
• Auto-héberger le portail du Centre d’API