Configurar o portal do Centro de API

Este artigo mostra como configurar o portal do Centro de API (versão prévia), um site gerenciado pelo Azure que os desenvolvedores e outros stakeholders da sua organização usam para descobrir as APIs em seu centro de API. Os usuários conectados podem procurar e filtrar APIs e exibir detalhes da API, como definições de API e documentação. O acesso do usuário às informações da API baseia-se na ID do Microsoft Entra e no controle de acesso baseado em função do Azure.

Pré-requisitos

• Um centro de API na sua assinatura do Azure. Se você ainda não criou um, consulte Início Rápido: criar seu centro de API.

• Permissões para criar um registro de aplicativo em um locatário do Microsoft Entra associado à sua assinatura do Azure e permissões para conceder acesso aos dados no centro da API.

Criar registro de aplicativo do Microsoft Entra

Primeiro, configure um registro de aplicativo no seu tenant do Microsoft Entra ID. O registro do aplicativo permite que o portal do Centro de API acesse dados do centro de API em nome de um usuário conectado.

O Centro de API pode configurar o registro do aplicativo automaticamente ou você pode criar o registro do aplicativo manualmente.

Configurar o registro do aplicativo automaticamente

Para configurar o registro do aplicativo automaticamente, siga estas etapas:

1. No portal do Azure, navegue até o centro de API.
2. No menu à esquerda, selecioneConfigurações do portal > do Centro de API.
3. Na guia Provedor de identidade , selecione Iniciar configuração.
4. Na guia Configuração rápida , selecione Salvar + publicar.

Se você precisar acessar o registro do aplicativo mais tarde, poderá encontrá-lo no portal em registros de aplicativo. O aplicativo é nomeado com o seguinte formato: <api-center-name-apic-aad>.

Configurar o registro do aplicativo manualmente

Se você quiser criar o registro do aplicativo manualmente, siga estas etapas:

1. No portal do Azure, navegue até o Microsoft Entra ID>Gerenciar>Registro de aplicativos.

2. Selecione + Novo registro.

3. Na página Registrar um aplicativo, defina os valores da seguinte forma:

   1. Definir Nome como um nome significativo, como api-center-portal
   2. Em Tipos de contas suportados, selecione Contas apenas neste diretório organizacional (<Nome do diretório> - Locatário único).
   3. No URI de Redirecionamento, selecione SPA (aplicativo de página única) e defina o URI. Insira o URI da implantação do portal do Centro de API no seguinte formulário: https://<service-name>.portal.<location>.azure-apicenter.ms. Substitua <service name> e <location> pelo nome do centro de API e o local onde ele é implantado, exemplo: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Selecione Registrar.

Configurar URIs de redirecionamento adicionais para a extensão do VS Code

Ao habilitar a exibição do portal do Centro de API na extensão do Visual Studio Code para o Centro de API, configure também as seguintes URIs de redirecionamento no registro do aplicativo:

1. No portal do Azure, navegue até o registro do aplicativo.

2. Na página Gerenciar>Autenticação , selecione Adicionar uma plataforma e selecione Aplicativos móveis e de área de trabalho.

3. Configure as três seguintes URIs de redirecionamento personalizadas:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Substitua <application-client-id> pelo ID do cliente deste aplicativo. Você pode encontrar esse valor na página Visão geral do registro do aplicativo.

Configurar e publicar o portal do Centro de API

Depois de criar o registro de aplicativo do portal do Centro de API, você pode personalizar as configurações e publicar o portal do Centro de API. Conclua as etapas a seguir no portal do Azure.

1. No portal do Azure, navegue até o centro de API.

2. No menu à esquerda, no portal do Centro de API, selecione Configurações.

   

3. Se você configurar um registro de aplicativo manualmente, na guia Provedor de identidade , selecione Iniciar configuração. Se você usou a configuração rápida, essa etapa já está concluída e você pode continuar com as configurações em outras guias.

   1. Na guia Manual , na ID do Cliente, insira a ID do Aplicativo (cliente) do registro do aplicativo criado na seção anterior.
   2. Confirme se o URI de Redirecionamento é o valor configurado no registro do aplicativo.
   3. Selecione Salvar + publicar.

4. Nas guias restantes, opcionalmente, personalize as configurações do portal do Centro de API. Para obter informações sobre as configurações, consulte Personalizar o portal do Centro de API.

5. Selecione Salvar + publicar.

Acessar o portal

Após a publicação, você pode acessar o portal do Centro de API no navegador.

• Na página Configurações do portal, selecione Exibir portal do Centro de API para abrir o portal em uma nova guia.
• Ou insira a seguinte URL no navegador, substituindo <service-name> e <location> usando o nome do centro de API e o local onde ela é implantada:
  https://<service-name>.portal.<location>.azure-apicenter.ms

Por padrão, a home page do portal pode ser acessada publicamente, mas requer entrada para acessar APIs. Consulte Habilitar entrada no portal por usuários e grupos do Microsoft Entra para obter detalhes sobre como configurar o acesso do usuário ao portal.

Habilitar a entrada no portal por usuários e grupos do Microsoft Entra

Para habilitar a entrada no portal do Centro de API para acessar APIs, atribua a função Leitor de Dados do Centro de API do Azure a usuários ou grupos em sua organização, com escopo para o centro de API.

Para obter pré-requisitos e etapas detalhados para atribuir uma função a usuários e grupos, consulte Atribuir funções do Azure usando o portal do Azure. Etapas breves a seguir:

1. No portal do Azure, navegue até o centro de API.
2. No menu à esquerda, selecione Controle de acesso (IAM)>+ Adicionar atribuição de função.
3. No painel Adicionar atribuição de função , defina os valores da seguinte maneira:
   1. Na página Função , pesquise e selecione Leitor de Dados do Centro de API do Azure. Selecione Próximo.
   2. Na página Membros, em Atribuir acesso a, selecione Usuário, grupo ou entidade de serviço>+ Selecionar membros.
   3. Na página Selecionar membros, pesquise e selecione os usuários ou grupos aos quais atribuir a função. Clique em Selecionar e em Avançar.
   4. Examine a atribuição de função e selecione Examinar + atribuir.

Depois de configurar o acesso ao portal, os usuários configurados poderão entrar no portal e exibir as APIs no centro de API.

Descoberta e consumo de API no portal do Centro de API

O portal do Centro de API dá suporte e simplifica o trabalho de desenvolvedores que usam e criam APIs em sua organização. Os usuários conectados podem:

• Pesquisar APIs por nome ou usando a pesquisa semântica assistida por IA

• Filtrar APIs por tipo ou estágio de ciclo de vida

• Exibir detalhes e definições da API , incluindo pontos de extremidade, métodos, parâmetros e formatos de resposta

• Baixar definições de API em um computador local ou abri-las no Visual Studio Code

• Experimentar APIs que dão suporte à autenticação de chave de API ou autorização do OAuth 2.0

Portais de Gerenciamento de API e API Center

O Gerenciamento de API do Azure e os serviços do Centro de API do Azure fornecem portais para que os desenvolvedores descubram e consumam APIs:

• O portal do desenvolvedor de Gerenciamento de API permite que os usuários encontrem APIs gerenciadas, aprendam a usá-las, solicitar acesso e testá-las.
• O portal do Centro de API (versão prévia) é um portal de vários gateways em que os usuários podem descobrir e filtrar o inventário de API completo da organização.

Embora os dois portais compartilhem alguns recursos, eles também têm diferenças distintas. A tabela a seguir compara os recursos atuais para ajudar a determinar qual portal usar. Algumas organizações podem preferir um portal, enquanto outras podem precisar de ambos.

¹ O portal do Centro de API pode conter todas as APIs em sua organização, incluindo as gerenciadas no Gerenciamento de API do Azure e em outras plataformas, bem como APIs e APIs não gerenciadas em desenvolvimento.

Conteúdo relacionado

• Personalizar o portal do Centro de API
• Habilitar e exibir o portal do Centro de API do Azure no Visual Studio Code
• Hospedar automaticamente o portal do Centro de API