Partilhar via

Migrar para o novo portal do programador

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 de programador legado encontra-se preterido e apenas receberá atualizações de segurança. Pode continuar a utilizá-lo, como de costume, até à descontinuação em outubro de 2023, altura em que será removido de todos os serviços de gestão de APIs.

Portal do desenvolvedor do 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. Possui um editor visual de arrastar e soltar para edição de conteúdo e um painel dedicado para designers estilizarem o site. Páginas, personalizações e configurações são salvas como recursos do Azure Resource Manager em seu serviço de Gerenciamento de API, que permite automatizar implantações de portal. Por fim, a base de código do portal é de código aberto, 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. Tem de recriar manualmente o conteúdo (páginas, texto, ficheiros multimédia) e personalizar o aspeto do novo portal. As etapas precisas variam dependendo das personalizações e da complexidade do seu portal. Consulte o tutorial do portal do desenvolvedor para obter orientações. 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á lançou o novo portal do desenvolvedor antes, mas não fez alterações, 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:

  • Se você expor seu portal do desenvolvedor por meio de um domínio personalizado, atribua um domínio ao novo portal do desenvolvedor. Utilize 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, precisará 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 estiver exposto à Internet por meio do Application Gateway, consulte este artigo da documentação para obter etapas de configuração precisas. Você precisa de:

    • Habilite a conectividade com o endpoint de gestão da Gestão de API.
    • Ative a conexão com o novo endpoint do portal.
    • Desative as regras selecionadas do Web Application Firewall.

  • Se alterou os modelos padrão de notificações por e-mail para incluir uma URL de portal obsoleta explicitamente especificada, 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 URL do portal interno, nenhuma alteração será necessária.

  • Problemas e aplicativos não são suportados no novo portal do desenvolvedor.

  • A integração direta com Facebook, Microsoft, Twitter e Google como provedores de identidade não é suportada no novo portal do desenvolvedor. Você pode integrar com esses provedores por meio do Azure AD B2C.

  • Se utilizar delegação, altere o URL de retorno nas suas aplicações e use o ponto de extremidade Obter Token de Acesso Partilhado em vez do ponto de extremidade Gerar URL SSO.

  • Se você usar o Microsoft Entra ID 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 Próprio, Sobrenome e ID de 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 modifique o sufixo:

    • De /docs/services/[serverName]/console/oauth2/authorizationcode/callback para /signin-oauth/code/callback/[serverName] no 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 autorizaçã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 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.
    • Do /docs/services/[serverName]/console/openidconnect/implicit/callback para /signin-oauth/implicit/callback para o fluxo de concessão implícita.

Próximos passos

Saiba mais sobre o portal do desenvolvedor: