Configurer votre portail du Centre d’API

Cet article explique comment configurer le portail du Centre d’API (préversion), 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. Les utilisateurs connectés peuvent parcourir et filtrer les API et afficher les détails de l’API, tels que les définitions d’API et la documentation. L’accès utilisateur aux informations d’API est basé sur l’ID Microsoft Entra et le contrôle d’accès en fonction du rôle Azure.

Conditions préalables

• Un Centre d’API dans votre abonnement Azure. Si vous n’en avez pas encore créé, consultez Démarrage rapide : Créer votre centre d’API.

• Autorisations de création d’une inscription d’application dans un locataire Microsoft Entra associé à votre abonnement Azure et autorisations pour accorder l’accès aux données dans votre centre d’API.

Créer une inscription d’application Microsoft Entra

Commencez par configurer une inscription d'applications dans votre tenant Microsoft Entra ID. L’inscription de l’application permet au portail du Centre d’API d’accéder aux données de votre centre d’API pour le compte d’un utilisateur connecté.

Le Centre d’API peut configurer automatiquement l’inscription d’application, ou vous pouvez créer manuellement l’inscription de l’application.

Configurer automatiquement l’inscription de l’application

Pour configurer automatiquement l’inscription de l’application, procédez comme suit :

1. Dans le Portail Microsoft Azure, accédez à votre centre API.
2. Dans le menu de gauche, sélectionnezParamètres du > du Centre des API.
3. Sous l’onglet Fournisseur d’identité , sélectionnez Démarrer la configuration.
4. Sous l’onglet Installation rapide , sélectionnez Enregistrer + publier.

Si vous avez besoin d’accéder à l’inscription de l’application ultérieurement, vous pouvez la trouver dans le portail sous Inscriptions d’applications. L’application est nommée au format suivant : <api-center-name-apic-aad>.

Configurer manuellement l’inscription de l’application

Si vous souhaitez créer manuellement l’inscription de l’application, procédez comme suit :

1. Dans le portail Azure, accédez à Microsoft Entra ID>Manage>App Registrations.

2. Sélectionnez + Nouvelle inscription.

3. Sur la page Inscrire une application, définissez les valeurs comme suit :

   1. Définissez Nom sur un nom significatif tel que api-center-portal
   2. Sous Types de compte pris en charge, sélectionnez Comptes dans cet annuaire organisationnel uniquement (<Nom de l’annuaire> – Locataire unique).
   3. Dans l’URI de redirection, sélectionnez Application monopage (SPA) et définissez l’URI. Entrez l’URI de votre déploiement du portail du Centre d’API, sous la forme suivante : https://<service-name>.portal.<location>.azure-apicenter.ms Remplacez <service name> et <location> par le nom de votre centre d'API et l'emplacement où il est déployé. Exemple : https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Sélectionnez Inscrire.

Configurer des URI de redirection supplémentaires pour l’extension VS Code

Lors de l’activation de l’affichage du portail du Centre d’API dans l’extension Visual Studio Code pour le Centre d’API, configurez également les URI de redirection suivants dans l’inscription de l’application :

1. Dans le portail Azure, accédez à votre inscription d’application.

2. Dans la page Gérer>l’authentification , sélectionnez Ajouter une plateforme , puis sélectionnez Applications mobiles et de bureau.

3. Configurez les trois URI de redirection personnalisés suivants :
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Remplacez <application-client-id> par l’ID d’application (client) de cette application. Vous trouverez cette valeur dans la page Vue d’ensemble de l’inscription de l’application.

Configurer et publier le portail du Centre d’API

Après avoir créé l’inscription de l’application du portail du Centre d’API, vous pouvez personnaliser les paramètres et publier votre portail du Centre d’API. Effectuez les étapes suivantes dans le portail Azure.

1. Dans le Portail Microsoft Azure, accédez à votre centre API.

2. Dans le menu de gauche, sous le portail du Centre des API, sélectionnez Paramètres.

   

3. Si vous configurez manuellement une inscription d’application, sous l’onglet Fournisseur d’identité, sélectionnez Démarrer. Si vous avez utilisé la configuration rapide, cette étape est déjà terminée et vous pouvez continuer à paramètres sur d’autres onglets.

   1. Sous l’onglet Manuel , dans l’ID client, entrez l’ID d’application (client) à partir de l’inscription de l’application que vous avez créée dans la section précédente.
   2. Vérifiez que l’URI de redirection est la valeur que vous avez configurée dans l’inscription de l’application.
   3. Sélectionnez Enregistrer + publier.

4. Sous les onglets restants, personnalisez éventuellement les paramètres de votre portail du Centre d’API. Pour plus d’informations sur les paramètres, consultez Personnaliser votre portail du Centre d’API.

5. Sélectionnez Enregistrer + publier.

Accéder au portail

Après la publication, vous pouvez accéder au portail du Centre des API dans votre navigateur.

• Dans la page Paramètres du portail, sélectionnez Afficher le portail du Centre d’API pour ouvrir le portail dans un nouvel onglet.
• Vous pouvez également entrer l’URL suivante dans votre navigateur, en remplaçant <service-name> et <location> par le nom de votre centre d’API et l’emplacement où il est déployé :
  https://<service-name>.portal.<location>.azure-apicenter.ms

Par défaut, la page d’accueil du portail est accessible publiquement, mais nécessite une connexion pour accéder aux API. Pour plus d’informations sur la configuration de l’accès utilisateur au portail, consultez Activer la connexion au portail par les utilisateurs et les groupes Microsoft Entra .

Activer la connexion au portail par les utilisateurs et groupes Microsoft Entra

Pour permettre à la connexion au portail du Centre des API d’accéder aux API, attribuez le rôle Lecteur de données du Centre d’API Azure aux utilisateurs ou groupes de votre organisation, limité à votre centre d’API.

Pour connaître les conditions préalables détaillées et les étapes à suivre pour attribuer un rôle aux utilisateurs et aux groupes, consultez Affecter des rôles Azure à l’aide du portail Azure. Les brèves étapes suivantes sont les suivantes :

1. Dans le Portail Microsoft Azure, accédez à votre centre API.
2. Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter une attribution de rôle.
3. Dans le volet Ajouter une attribution de rôle , définissez les valeurs comme suit :
   1. Dans la page Rôle , recherchez et sélectionnez Lecteur de données du Centre d’API Azure. Cliquez sur Suivant.
   2. Dans la page Membres, Dans Affecter l’accès, sélectionnez Utilisateur, groupe ou principal> de service+ Sélectionner des membres.
   3. Dans la page Sélectionner des membres , recherchez et sélectionnez les utilisateurs ou les groupes auxquels attribuer le rôle. Cliquez sur Sélectionner , puis sur Suivant.
   4. Vérifiez l'attribution du rôle, puis sélectionnez Vérifier + attribuer.

Après avoir configuré l’accès au portail, les utilisateurs configurés peuvent se connecter au portail et afficher les API dans votre centre d’API.

Découverte et consommation d’API dans le portail du Centre d’API

Le portail du Centre d’API prend en charge et simplifie le travail des développeurs qui utilisent et créent des API au sein de votre organisation. Les utilisateurs connectés peuvent :

• Rechercher des API par nom ou à l’aide de la recherche sémantique assistée par IA

• Filtrer les API par type ou étape de cycle de vie

• Afficher les détails et définitions de l’API , notamment les points de terminaison, les méthodes, les paramètres et les formats de réponse

• Télécharger des définitions d’API sur un ordinateur local ou les ouvrir dans Visual Studio Code

• Essayer des API qui prennent en charge l’authentification par clé d’API ou l’autorisation OAuth 2.0

Portails Gestion des API et Centre d’API

Les services Gestion des API Azure et Azure API Center fournissent tous deux des portails aux développeurs pour découvrir et consommer des API :

• Le portail des développeurs Gestion des API permet aux utilisateurs de rechercher des API managées (y compris des groupes d’API gérées en tant que produits), d’apprendre à les utiliser, à demander l’accès et à les tester.
• Le portail du Centre des API (préversion) est un portail multigate où les utilisateurs peuvent découvrir et filtrer l’inventaire complet des API de l’organisation.

Bien que les deux portails partagent certaines fonctionnalités, ils ont également des différences distinctes. Le tableau suivant compare les fonctionnalités actuelles pour déterminer le portail à utiliser. Certaines organisations peuvent préférer un portail, tandis que d’autres peuvent avoir besoin des deux.

¹ Le portail du Centre des API peut contenir toutes les API de votre organisation, y compris celles gérées dans Gestion des API Azure et d’autres plateformes, ainsi que les API et API non managées en cours de développement.

Contenu connexe

• Personnaliser votre 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