Partager via

Migrer vers le nouveau portail des développeurs

  • Article

Cet article décrit les étapes à suivre pour migrer du portail hérité déconseillé vers le nouveau portail des développeurs dans Gestion des API.

Important

Le portail des développeurs hérité est désormais déconseillé et recevra uniquement des mises à jour de sécurité. Vous pouvez continuer à l’utiliser normalement jusqu’à sa suppression en octobre 2023, lorsqu’il sera supprimé de tous les services de gestion des API.

Portail des développeurs Gestion des API

Disponibilité

Important

Cette fonctionnalité est disponible dans les niveaux Premium, Standard, De base et Développeur de Gestion des API.

Pour connaître la disponibilité des fonctionnalités dans les niveaux v2 (préversion), consultez vue d’ensemble des niveaux v2.

Améliorations apportées au nouveau portail des développeurs

Le nouveau portail des développeurs résout de nombreuses limitations du portail déconseillé. Il comporte un éditeur visuel par glisser-déposer pour modifier le contenu et un panneau dédié aux concepteurs pour définir le style du site web. Les pages, les personnalisations et la configuration sont enregistrées en tant que ressources Azure Resource Manager dans votre service Gestion des API, ce qui vous permet d’automatiser les déploiements du portail. Enfin, le codebase du portail est open source, vous pouvez donc l’enrichir avec des fonctionnalités personnalisées.

Comment migrer vers le nouveau portail des développeurs

Le nouveau portail des développeurs est incompatible avec le portail déconseillé ; la migration automatisée n’est pas possible. Vous devez recréer manuellement le contenu (pages, texte, fichiers multimédias) et personnaliser l’apparence du nouveau portail. Les étapes précises varient en fonction des personnalisations et de la complexité de votre portail. Pour obtenir de l’aide, consultez le tutoriel sur le portail des développeurs. La configuration restante, par exemple la liste des API, des produits, des utilisateurs et des fournisseurs d’identité, est automatiquement partagée entre les deux portails.

Important

Si vous avez déjà lancé le nouveau portail des développeurs, mais que vous n’avez effectué aucune modification, réinitialisez le contenu par défaut pour le mettre à jour à la version la plus récente.

Lorsque vous migrez depuis le portail déconseillé, gardez à l’esprit les modifications suivantes :

  • Si vous exposez votre portail des développeurs à l’aide d’un domaine personnalisé, attribuez un domaine au nouveau portail des développeurs. Utilisez l’option Portail des développeurs dans la liste déroulante du portail Azure.

  • Appliquez une stratégie CORS sur vos API pour activer la console de test interactive.

  • Si vous injectez du code CSS personnalisé pour appliquer un style au portail, vous devez reproduire le style à l’aide du panneau de conception intégré. L’injection de code CSS n’est pas autorisée dans le nouveau portail.

  • Vous pouvez injecter du code JavaScript personnalisé uniquement dans la version auto-hébergée du nouveau portail.

  • Si votre instance Gestion des API se trouve dans un réseau virtuel et est exposée à Internet via Application Gateway, consultez cet article de la documentation pour connaître les étapes précises de configuration. Vous devez :

    • Activer la connectivité au point de terminaison de gestion de Gestion des API.
    • Activer la connectivité au point de terminaison du nouveau portail.
    • Désactiver certaines règles de Web Application Firewall.

  • Si vous avez modifié les modèles de notification par e-mail par défaut pour inclure une URL du portail déconseillé qui est explicitement définie, modifiez-les pour qu’ils utilisent le paramètre « URL du portail » ou pointent vers l’URL du nouveau portail. Si les modèles utilisent le paramètre « URL du portail » intégré à la place, aucune modification n’est requise.

  • Problèmes et Applications ne sont pas pris en charge dans le nouveau portail des développeurs.

  • L’intégration directe à Facebook, Microsoft, Twitter et Google comme fournisseurs d’identité n’est pas prise en charge dans le nouveau portail des développeurs. Vous pouvez intégrer ces fournisseurs à l’aide d’Azure AD B2C.

  • Si vous utilisez la délégation, modifiez l’URL de retour dans vos applications et utilisez le point de terminaison d’API Recevoir un jeton d’accès partagé au lieu du point de terminaison Générer l’URL SSO.

  • Si vous utilisez Microsoft Entra ID comme fournisseur d’identité :

    • Modifiez l’URL de retour dans votre application pour qu’elle pointe vers le nouveau domaine du portail des développeurs.
    • Modifiez le suffixe /signin-aad de l’URL de retour dans votre application en /signin.

  • Si vous utilisez Azure AD B2C en tant que fournisseur d’identité :

    • Modifiez l’URL de retour dans votre application pour qu’elle pointe vers le nouveau domaine du portail des développeurs.
    • Modifiez le suffixe /signin-aad de l’URL de retour dans votre application en /signin.
    • Incluez Prénom, Nom de famille et ID d’objet de l’utilisateur dans les revendications d’application.

  • Si vous utilisez OAuth 2.0 dans la console de test interactive, modifiez l’URL de retour dans votre application pour qu’elle pointe vers le domaine du nouveau portail des développeurs et modifiez le suffixe :

    • /docs/services/[serverName]/console/oauth2/authorizationcode/callback en /signin-oauth/code/callback/[serverName] pour le flux d’octroi du code d’autorisation.
    • /docs/services/[serverName]/console/oauth2/implicit/callback en /signin-oauth/implicit/callback pour le flux d’octroi implicite.

  • Si vous utilisez OpenID Connect dans la console de test interactive, modifiez l’URL de retour dans votre application pour qu’elle pointe vers le domaine du nouveau portail des développeurs et modifiez le suffixe :

    • /docs/services/[serverName]/console/openidconnect/authorizationcode/callback en /signin-oauth/code/callback/[serverName] pour le flux d’octroi du code d’autorisation.
    • /docs/services/[serverName]/console/openidconnect/implicit/callback en /signin-oauth/implicit/callback pour le flux d’octroi implicite.

Étapes suivantes

Pour plus d’informations sur le portail des développeurs :