Configurar o portal do Centro de API

Este artigo mostra como configurar o portal da Central de APIs (visualização), um site gerenciado pelo Azure que os desenvolvedores e outras partes interessadas em sua organização usam para descobrir as APIs em sua central de APIs. Os usuários conectados podem navegar 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 é baseado na ID do Microsoft Entra e no controle de acesso baseado em função do Azure.

Pré-requisitos

• Um centro de API na sua subscrição do Azure. Se você ainda não criou um, consulte Guia de início rápido: criar sua central de API.

• Permissões para criar um registo de aplicação num inquilino do Microsoft Entra associado à sua subscrição do Azure e permissões para conceder acesso aos dados no seu centro de APIs.

Criar registo da aplicação Microsoft Entra

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

A Central de APIs pode configurar o registro do aplicativo automaticamente ou você pode criar o registro do aplicativo manualmente.

Configurar o registo da aplicação automaticamente

Para configurar o registo da aplicação automaticamente, siga estes passos:

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

Se precisar de aceder ao registo da aplicação mais tarde, pode encontrá-la no portal em Registos da aplicação. O aplicativo é nomeado com o seguinte formato: <api-center-name-apic-aad>.

Configurar o registo da aplicação manualmente

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

1. No portal do Azure, navegue até Microsoft Entra ID>Manage>App registrations.

2. Selecione + Novo registo.

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

   1. Defina Name como um nome significativo, como api-center-portal
   2. Em Tipos de conta suportados, selecione Contas somente neste diretório organizacional (<Nome do diretório> - Locatário único).
   3. Em Redirecionar URI, selecione Aplicativo de página única (SPA) e defina o URI. Insira o URI da implantação do portal do Centro de APIs, no seguinte formato: https://<service-name>.portal.<location>.azure-apicenter.ms. Substitua <service name> e <location> pelo nome do seu centro de API e o local onde ele foi implantado, Exemplo: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Selecione Register.

Configurar URIs de redirecionamento adicionais para extensão VS Code

Ao habilitar a exibição do portal da Central de APIs na extensão de código do Visual Studio para a Central de APIs, configure também os seguintes URIs de redirecionamento no registro do aplicativo:

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

2. Na página Gerir>Autenticação , selecione Adicionar uma plataforma e selecione Aplicações móveis e de ambiente de trabalho.

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

   Substitua <application-client-id> pelo ID da aplicação (cliente) deste programa. 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 do aplicativo do portal da Central de APIs, você pode personalizar as configurações e publicar o portal da Central de APIs. Conclua as etapas a seguir no portal do Azure.

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

2. No menu à esquerda, em Portal do Centro de APIs, 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, esta etapa já está concluída e você pode continuar com as configurações em outras guias.

   1. Na guia Manual , em ID do cliente, insira a ID do aplicativo (cliente) do registro do aplicativo que você criou na seção anterior.
   2. Confirme se o URI de redirecionamento é o valor que você configurou no registro do aplicativo.
   3. Selecione Salvar + publicar.

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

5. Selecione Salvar + publicar.

Aceder ao portal

Depois de publicar, você pode acessar o portal do Centro de API em seu 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 o seguinte URL no navegador, substituindo <service-name> e <location> com o nome do seu centro de API e o local onde ele foi implantado:
  https://<service-name>.portal.<location>.azure-apicenter.ms

Por padrão, a home page do portal pode ser acessada publicamente, mas requer login 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 APIs 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 APIs.

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

1. No portal do Azure, navegue até o centro de APIs.
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 forma:
   1. Na página Função , procure e selecione Leitor de Dados do Centro de API do Azure. Selecione Seguinte.
   2. Na página Membros, em Atribuir acesso a, selecione Utilizador, 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 seguida, em Seguinte.
   4. Revise a atribuição de função e selecione Rever + atribuir.

Depois de configurar o acesso ao portal, os usuários configurados podem entrar no portal e exibir as APIs em seu centro de APIs.

Descoberta e consumo de API no portal do Centro de API

O portal do Centro de API suporta e simplifica o trabalho de desenvolvedores que usam e criam APIs em sua organização. Os utilizadores com sessão iniciada podem:

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

• Filtrar APIs por tipo ou estágio do 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 para um computador local ou abri-las no Visual Studio Code

• Experimente APIs que suportam autenticação de chave de API ou autorização OAuth 2.0

Gerenciamento de API e portais do Centro de API

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

• O portal de programadores de Gestão de APIs permite aos utilizadores encontrar APIs geridas (incluindo grupos de APIs geridas como produtos), aprender a usá-las, solicitar acesso e testá-las.
• O portal API Center (pré-visualização) é um portal multigateway onde os utilizadores podem descobrir e filtrar o inventário completo de APIs 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 na sua organização, incluindo as geridas na Gestão de API do Azure e noutras plataformas, bem como APIs não geridas e APIs em desenvolvimento.

Conteúdo relacionado

• Personalize seu portal do Centro de API
• Habilitar e exibir o portal do Centro de API do Azure no Visual Studio Code
• Auto-hospedar o portal do Centro de API