Migrar para o novo portal do desenvolvedor

Este artigo descreve as etapas necessárias para migrar do portal herdado preterido para o novo portal do desenvolvedor no Gerenciamento de API.

Importante

O portal herdado foi preterido e receberá apenas atualizações de segurança. Você pode continuar usando-o, como de costume, até a desativação dele em outubro de 2023, quando ele será removido de todos os serviços de Gerenciamento de API.

Disponibilidade

Importante

Este recurso está disponível nas camadas Premium, Standard, Básico e Desenvolvedor do Gerenciamento de API.

Para obter a disponibilidade de recursos nas camadas v2 (versão prévia), consulte a visão geral das camadas v2.

Aprimoramentos no novo portal do desenvolvedor

O novo portal do desenvolvedor resolve muitas limitações do portal preterido. Ele apresenta um editor visual de arrastar e soltar para a edição de conteúdos e um painel dedicado à estilização do site para os designers. As páginas, personalizações e configurações são salvas como recursos do Azure Resource Manager no serviço de gerenciamento de API, o que permite automatizar implantações do portal. Por fim, a base de código do portal é de software livre, o que permite que ela seja estendida com a funcionalidade personalizada.

Como migrar para o novo portal do desenvolvedor

O novo portal do desenvolvedor é incompatível com o preterido e não é possível realizar a migração automatizada. Você precisa recriar manualmente o conteúdo (páginas, texto, arquivos de mídia) e personalizar a aparência do novo portal. As etapas exatas a serem seguidas variam de acordo com as personalizações e a complexidade do portal. Consulte o tutorial do portal do desenvolvedor para obter diretrizes. As configurações restantes, como a lista de APIs, produtos, usuários e provedores de identidade, são compartilhadas automaticamente entre os dois portais.

Importante

Se você tiver iniciado o novo portal do desenvolvedor antes, mas não tiver feito nenhuma alteração, redefina o conteúdo padrão para atualizá-lo para a versão mais recente.

Ao migrar do portal preterido, lembre-se das seguintes alterações:

• Ao expor o portal do desenvolvedor por meio de um domínio personalizado, atribua um domínio para o novo portal. Use a opção Portal do desenvolvedor no menu suspenso do portal do Azure.

• Aplique uma política CORS às suas APIs para habilitar o console de teste interativo.

• Ao injetar CSS personalizado para estilizar o portal, deve-se replicar o estilo com o painel de design interno. A injeção de CSS não é permitida no novo portal.

• Você só pode injetar JavaScript personalizado na versão hospedada internamente do novo portal.

• Se o gerenciamento de API estiver em uma rede virtual e exposto à Internet por meio do gateway de aplicativo, consulte este artigo da documentação para obter as etapas exatas de configuração. Você precisa:

  • Habilite a conectividade com o ponto de extremidade de gerenciamento do gerenciamento de API.
  • Habilite a conectividade com o novo ponto de extremidade do portal.
  • Desabilite as regras de firewall do aplicativo Web selecionadas.

• Se você tiver alterado os modelos de notificação por email padrão para incluir uma URL do portal preterido explicitamente definida, altere-os para que usem o parâmetro da URL do portal ou apontem para a URL do novo portal. Se os modelos usarem o parâmetro da URL do portal interno, nenhuma alteração será necessária.

• Não há suporte para problemas e aplicativos no novo portal do desenvolvedor.

• Não há suporte para integração direta com o Facebook, a Microsoft, o Twitter e o Google como provedores de identidade no novo portal do desenvolvedor. Você pode integrar esses provedores por meio do Azure AD B2C.

• Se você usar a delegação, altere a URL de retorno nos aplicativos e use o ponto de extremidade de API Obter token de acesso compartilhado em vez do ponto de extremidade Gerar URL de SSO.

• Se você usar Microsoft Entra ID como um provedor de identidade:

  • Altere a URL de retorno no aplicativo para apontar para o domínio do novo portal do desenvolvedor.
  • Modifique o sufixo da URL de retorno no aplicativo de /signin-aad para /signin.

• Ao usar o Azure AD B2C como um provedor de identidade:

  • Altere a URL de retorno no aplicativo para apontar para o domínio do novo portal do desenvolvedor.
  • Modifique o sufixo da URL de retorno no aplicativo de /signin-aad para /signin.
  • Inclua o Nome fornecido, o Sobrenome e o ID do objeto do usuário nas declarações do aplicativo.

• Se você usar o OAuth 2.0 no console de teste interativo, altere a URL de retorno no aplicativo para apontar para o domínio do novo portal do desenvolvedor e modifique o sufixo:

  • De /docs/services/[serverName]/console/oauth2/authorizationcode/callback para /signin-oauth/code/callback/[serverName] para o fluxo de concessão de código de autorização.
  • De /docs/services/[serverName]/console/oauth2/implicit/callback para /signin-oauth/implicit/callback para o fluxo de concessão implícita.

• Se você usar o OpenID Connect no console de teste interativo, altere a URL de retorno no aplicativo para apontar para o domínio do novo portal do desenvolvedor e modifique o sufixo:

  • De /docs/services/[serverName]/console/openidconnect/authorizationcode/callback para /signin-oauth/code/callback/[serverName] para o fluxo de concessão de código de autorização.
  • De /docs/services/[serverName]/console/openidconnect/implicit/callback para /signin-oauth/implicit/callback para o fluxo de concessão implícita.

Próximas etapas

Saiba mais sobre o portal do desenvolvedor:

• Visão Geral do portal do desenvolvedor do Gerenciamento de API do Azure
• Acessar e personalizar o portal do desenvolvedor