Compartilhar via

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.

Portal do desenvolvedor de Gerenciamento de API

APLICA-SE A: Desenvolvedor | Básico | Padrão | Premium

Melhorias no novo portal do desenvolvedor

O novo portal do desenvolvedor aborda muitas limitações do portal preterido. Ele apresenta um editor de arrastar e soltar visual para edição de conteúdo e um painel dedicado para designers estilizarem o site. Páginas, personalizações e configuração são salvas como recursos do Azure Resource Manager em seu serviço de Gerenciamento de API, que permite automatizar implantações do portal. Por fim, a base de código do portal é de software livre, para que você possa estendê-la com funcionalidade personalizada.

Como migrar para o novo portal do desenvolvedor

O novo portal do desenvolvedor é incompatível com o portal preterido e a migração automatizada não é possível. Você precisa recriar manualmente o conteúdo (páginas, texto, arquivos de mídia) e personalizar a aparência do novo portal. As etapas precisas variarão dependendo das personalizações e da complexidade do seu portal. Consulte o tutorial do portal do desenvolvedor para obter diretrizes . A configuração restante, como a lista de APIs, produtos, usuários, provedores de identidade, é compartilhada automaticamente em ambos os portais.

Importante

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

Ao migrar do portal preterido, tenha em mente as seguintes alterações:

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

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

  • Se você injetar CSS personalizado para estilizar o portal, será necessário replicar o estilo usando o painel de design interno. A injeção de CSS não é permitida no novo portal.

  • Você pode injetar JavaScript personalizado somente na versão auto-hospedada do novo portal.

  • Se o Gerenciamento de API estiver em uma rede virtual e for exposto à Internet por meio do Gateway de Aplicativo, consulte este artigo de documentação para obter etapas precisas de configuração. Você precisa:

    • Habilite a conectividade com o endpoint de gerenciamento do API Management.
    • Ative a conexão com o novo ponto de acesso do portal.
    • Desabilite as regras de Firewall do Aplicativo Web selecionadas.

  • Se você alterou os modelos de notificação de email padrão para incluir uma URL do portal preterida explicitamente definida, altere-os para usar o parâmetro de URL do portal ou aponte para a nova URL do portal. Se os modelos usarem o parâmetro de URL do portal interno, nenhuma alteração será necessária.

  • No novo portal do desenvolvedor, não há suporte para questões nem para aplicativos.

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

  • Se você usar delegação, altere a URL de retorno nos seus aplicativos e use o endpoint da API de Token de Acesso Compartilhado em vez do endpoint Gerar URL de SSO.

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

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

  • Se você usar o Azure AD B2C como um provedor de identidade:

    • Altere a URL de retorno em seu aplicativo para apontar para o novo domínio do portal do desenvolvedor.
    • Modifique o sufixo da URL de retorno em seu aplicativo de /signin-aad para /signin.
    • Inclua Nome, Sobrenome e 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 em seu aplicativo para apontar para o novo domínio do portal do desenvolvedor e modificar o sufixo:

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

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

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

Próximas etapas

Saiba mais sobre o portal do desenvolvedor:

  • Last updated on