Configurar o gerenciador de credenciais – API do GitHub

APLICA-SE A: todas as camadas do Gerenciamento de API

Neste artigo, você aprenderá a criar uma conexão gerenciada no Gerenciamento de API e chamar uma API do GitHub que exige um token OAuth 2.0. Este exemplo usa o tipo de concessão do código de autorização.

Você aprenderá como:

Pré-requisitos

• Uma conta do GitHub.
• Uma instância de Gerenciamento de API em execução. Se você precisar de uma, crie uma instância do Gerenciamento de API do Azure.
• Habilite uma identidade gerenciada atribuída pelo sistema para o Gerenciamento de API na instância de Gerenciamento de API.

Etapa 1: Registrar um aplicativo no GitHub

Crie um aplicativo OAuth do GitHub para a API e dê a ele as permissões apropriadas para as solicitações que você deseja chamar.

1. Faça login no GitHub.

2. Em seu perfil de conta, vá para Configurações > Configurações do Desenvolvedor > Aplicativos OAuth. Selecione Novo aplicativo OAuth.

   

   1. Insira um nome de aplicativo e uma URL de home page para o aplicativo. Para este exemplo, você pode fornecer uma URL de marcador de posição, como http://localhost.
   2. Opcionalmente, adicione uma descrição do aplicativo.
   3. Na URL de retorno de chamada de autorização (a URL de redirecionamento), insira https://authorization-manager.consent.azure-apim.net/redirect/apim/<YOUR-APIM-SERVICENAME>, substituindo o nome da instância de Gerenciamento de API em que você configura o provedor de credenciais.
   4. Opcionalmente, selecione Habilitar fluxo de dispositivo (não necessário para este exemplo).

3. Selecione Registrar aplicativo.

4. Na página Geral , copie a ID do cliente, que você usa na Etapa 2.

5. Selecione Gerar um novo segredo do cliente. Copie o segredo, que não é exibido novamente. Configure o segredo na Etapa 2.

   

Etapa 2: Configurar um provedor de credenciais no Gerenciamento de API

1. Entre no portal do Azure e vá para sua instância de Gerenciamento de API.

2. No menu à esquerda, selecione APIs>Credential manager>+ Create.

   

3. Em Criar provedor de credenciais, insira as seguintes configurações:

   Configurações	Value
   Nome do provedor de credenciais	Um nome de sua escolha, como github-01
   Provedor de identidade	Selecionar GitHub
   Tipo de concessão	Selecionar código de autorização
   ID do cliente	Cole o valor copiado anteriormente do registro do aplicativo
   Segredo do cliente	Cole o valor copiado anteriormente do registro do aplicativo
   Âmbito	Para este exemplo, defina o escopo como Usuário

4. Selecione Criar.

5. Quando solicitado, examine a URL de redirecionamento do OAuth exibida e selecione Sim para confirmar se ela corresponde à URL inserida no registro do aplicativo GitHub.

Etapa 3: Configurar uma conexão

Na guia Conexão , conclua as etapas para sua conexão com o provedor.

1. Insira um nome de conexão e, em seguida, selecione Salvar.
2. Na Etapa 2: Faça logon em sua conexão (para o tipo de concessão de código de autorização), selecione o botão Logon . Conclua as etapas com seu provedor de identidade para autorizar o acesso e retorne ao Gerenciamento de API.
3. Na Etapa 3: Determinar quem terá acesso a essa conexão (política de acesso), o membro de identidade gerenciada está listado. Adicionar outros membros é opcional, dependendo do seu cenário.
4. Selecione Concluir.

A nova conexão aparece na lista de conexões e mostra um status de Conectado. Se você quiser criar outra conexão para o provedor de credenciais, conclua as etapas anteriores.

Etapa 4: Criar uma API no Gerenciamento de API e configurar uma política

1. Entre no portal do Azure e vá para sua instância de Gerenciamento de API.

2. No menu à esquerda, selecione APIs>APIs>+ Adicionar API.

3. Selecione HTTP e insira as seguintes configurações e selecione Criar.

   Configurações	Value
   Nome de exibição	githubuser
   URL do serviço Web	https://api.github.com
   Sufixo de URL da API	githubuser

4. Vá para a nova API e selecione Adicionar Operação. Insira as configurações a seguir e selecione Salvar.

   Configurações	Value
   Nome de exibição	getauthdata
   URL para GET	/user

   

5. Siga as etapas anteriores para adicionar outra operação com as seguintes configurações.

   Configurações	Value
   Nome de exibição	getauthfollowers
   URL para GET	/user/followers

6. Selecione Todas as operações. Na seção Processamento de Entrada , selecione o ícone (</>) (editor de código).

7. Copie e cole o código a seguir no editor de políticas. Verifique se os valores provider-id e authorization-id na política get-authorization-context correspondem aos nomes do provedor de credenciais e da conexão, respectivamente, configurados nas etapas anteriores. Clique em Salvar.

   <policies>
       <inbound>
           <base />
           <get-authorization-context provider-id="github-01" authorization-id="first-connection" context-variable-name="auth-context" identity-type="managed" ignore-error="false" />
           <set-header name="Authorization" exists-action="override">
               <value>@("Bearer " + ((Authorization)context.Variables.GetValueOrDefault("auth-context"))?.AccessToken)</value>
           </set-header>
           <set-header name="User-Agent" exists-action="override">
               <value>API Management</value>
           </set-header>
       </inbound>
       <backend>
           <base />
       </backend>
       <outbound>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

A definição de política anterior consiste em três partes:

• A política get-authorization-context busca um token de autorização fazendo referência ao provedor de credenciais e à conexão que você criou anteriormente.
• A primeira política set-header cria um cabeçalho HTTP com o token de autorização buscado.
• A segunda política configurar cabeçalho cria um User-Agent cabeçalho (requisito da API do GitHub).

Etapa 5: Testar a API

1. Na guia Teste , selecione uma operação que você configurou.

2. Selecione Enviar.

   

   Uma resposta bem-sucedida retorna dados do usuário da API do GitHub.

Conteúdo relacionado

• Saiba mais sobre políticas de autenticação e autorização
• Saiba mais sobre a API REST do GitHub