Migrar para o novo portal de programador

Este artigo descreve os passos que tem de seguir para migrar do portal legado preterido para o novo portal de programador no Gestão 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 habitualmente, até à descontinuação em outubro de 2023, altura em que será removido de todos os serviços de Gestão de API.

Disponibilidade

Importante

Esta funcionalidade está disponível nos escalões Premium, Standard, Básico e Programador da Gestão de API.

Para obter a disponibilidade de funcionalidades nas camadas v2 (pré-visualização), veja a descrição geral das camadas v2.

Melhorias no novo portal do programador

O novo portal de programador aborda muitas limitações do portal preterido. Apresenta um editor de arrastar e largar elementos visuais para editar conteúdo e um painel dedicado para os designers modelarem o site. As páginas, personalizações e configuração são guardadas como recursos do Azure Resource Manager no seu serviço de Gestão de API, o que lhe permite automatizar as implementações do portal. Por fim, o codebase do portal é open source, pelo que pode expandi-lo com funcionalidades personalizadas.

Como migrar para o novo portal do programador

O novo portal de programador é 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. Os passos precisos variam consoante as personalizações e a complexidade do portal. Veja o tutorial do portal do programador para obter orientações. A configuração restante, como a lista de APIs, produtos, utilizadores, fornecedores de identidade, é partilhada automaticamente em ambos os portais.

Importante

Se já iniciou o novo portal de programador, mas não fez alterações, reponha o conteúdo predefinido para atualizá-lo para a versão mais recente.

Quando migrar do portal preterido, tenha em atenção as seguintes alterações:

• Se expor o portal do programador através de um domínio personalizado, atribua um domínio ao novo portal de programador. Utilize a opção Portal do programador no menu pendente do portal do Azure.

• Aplique uma política CORS nas SUAS APIs para ativar a consola de teste interativa.

• Se injetar CSS personalizado para modelar o portal, terá de replicar o estilo com o painel de estrutura incorporado. A injeção de CSS não é permitida no novo portal.

• Só pode injetar JavaScript personalizado na versão autoalojada do novo portal.

• Se o seu Gestão de API estiver numa rede virtual e estiver exposto à Internet através de Gateway de Aplicação, consulte este artigo de documentação para obter passos de configuração precisos. Tem de:

  • Ative a conectividade ao ponto final de gestão do Gestão de API.
  • Ative a conectividade ao novo ponto final do portal.
  • Desative as regras de Firewall de Aplicações Web selecionadas.

• Se alterou os modelos de notificação de e-mail predefinidos para incluir um URL do portal preterido explicitamente, altere-os para utilizar o parâmetro de URL do portal ou aponte para o novo URL do portal. Se os modelos utilizarem o parâmetro de URL do portal incorporado, não são necessárias alterações.

• Os problemas e as Aplicações não são suportados no novo portal do programador.

• A integração direta com o Facebook, Microsoft, Twitter e Google como fornecedores de identidade não é suportada no novo portal de programadores. Pode integrar-se nesses fornecedores através do Azure AD B2C.

• Se utilizar a delegação, altere o URL de retorno nas suas aplicações e utilize o ponto final da API Get Shared Access Token em vez do ponto final Gerar URL do SSO.

• Se utilizar Microsoft Entra ID como fornecedor de identidade:

  • Altere o URL de devolução na sua aplicação para apontar para o novo domínio do portal do programador.
  • Modifique o sufixo do URL de retorno na sua aplicação de /signin-aad para /signin.

• Se utilizar Azure AD B2C como fornecedor de identidade:

  • Altere o URL de devolução na sua aplicação para apontar para o novo domínio do portal do programador.
  • Modifique o sufixo do URL de retorno na sua aplicação de /signin-aad para /signin.
  • Inclua Nome Indicado, Apelido e ID de Objeto do Utilizador nas afirmações da aplicação.

• Se utilizar o OAuth 2.0 na consola de teste interativa, altere o URL de retorno na sua aplicação para apontar para o novo domínio do portal do programador e modifique o sufixo:

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

• Se utilizar o OpenID Connect na consola de teste interativa, altere o URL de retorno na sua aplicação para apontar para o novo domínio do portal do programador e modifique o sufixo:

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

Passos seguintes

Saiba mais sobre o portal do programador:

• Descrição geral do portal do programador da Gestão de API do Azure
• Aceder e personalizar o portal do programador