OAuth 2.0: configurar um novo proxy de API

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

O tipo de concessão de credenciais de cliente define um procedimento para emitir tokens de acesso em troca de credenciais da app. Estas credenciais da app são o par de chave do consumidor e segredo que o Apigee emite para cada app registada numa organização. Para mais detalhes, consulte o artigo Implementar o tipo de concessão de código de autorização.

Adicione o OAuth v2.0 a um novo proxy de API

Pode adicionar a validação OAuth a uma API quando cria um novo proxy de API na IU do Apigee.

Para adicionar a validação OAuth a uma API:

Apigee na Cloud Console

  1. Na Google Cloud consola, aceda à página Desenvolvimento de proxy > Proxies de API.

    Aceda aos proxies de API

  2. Selecione a sua organização no selecionador de projetos no painel Google Cloud . O nome da organização é igual ao Google Cloud nome do projeto.
  3. No painel Proxies de API, clique em + Criar.
  4. No painel Criar um proxy, em Modelo de proxy, selecione Proxy inverso (mais comum).
  5. Configure o proxy com o seguinte:
    Nome Valor
    Nome do proxy helloworld_oauth2
    Caminho base

    /hellooauth2

    O caminho base do projeto faz parte do URL usado para fazer pedidos ao proxy da API.
    Descrição hello world protected by OAuth v2.0
    Destino (API existente)

    https://mocktarget.apigee.net/ip

    Isto define o URL de destino que o Apigee invoca num pedido ao proxy de API. Este destino devolve apenas uma resposta simples: Hello, Guest!.
  6. Clicar em Seguinte.
  7. Implementar (opcional):
    • Ambientes de implementação: opcional. Use as caixas de verificação para selecionar um ou mais ambientes nos quais implementar o proxy. Se preferir não implementar o proxy neste momento, deixe o campo Ambientes de implementação vazio. Pode sempre implementar o proxy mais tarde.
    • Conta de serviço: opcional. Anexe uma conta de serviço à implementação para permitir que o proxy aceda aos Google Cloud serviços, conforme especificado na função e nas autorizações da conta de serviço.
  8. Clique em Criar.
  9. No painel Resumo do proxy para o proxy helloworld_apikey, clique no separador Desenvolver.
  10. No menu Políticas, clique em Adicionar política.
  11. No painel Criar política, em Segurança, selecione Validar chave da API.
  12. No painel Validar chave da API, preencha os campos obrigatórios nas secções Nome e Nome a apresentar com os seguintes valores:
    • Nome: introduza um nome da política. Por exemplo, VerifyAPIKey.
    • Nome a apresentar: introduza o nome da política para utilização na IU. Por exemplo, Verify API Key.
  13. Clique em Criar.
  14. Clique em para adicionar outra política.
  15. No painel Criar política, em Mediação, selecione Atribuir mensagem.
  16. No painel Atribuir mensagem, preencha os campos obrigatórios nas secções Nome e Nome a apresentar com os seguintes valores:
    • Nome: introduza um nome da política. Por exemplo, AssignMessage.
    • Nome a apresentar: introduza o nome da política para utilização na IU. Por exemplo, Assign Message.
  17. Clique em Criar.

  18. Atualizar os conteúdos da política de Atribuição de mensagens para o seguinte:

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. Adicione as políticas VerifyApiKey e Remove Header Authorization.
    1. No menu Pontos finais de proxy, clique em Preflow.
    2. No painel Pedido do editor visual, clique em Adicionar etapa de política.
    3. No painel do passo Adicionar política, selecione Validar chave da API.
    4. Clique em Adicionar.
    5. No painel Pedido do editor visual, clique em Adicionar etapa de política.
    6. No painel Adicionar passo de política, selecione Remover autorização de cabeçalho.
    7. Clique em Adicionar.
  20. Clique em Guardar.

IU clássica

  1. Inicie sessão na IU do Apigee.
  2. Selecione Desenvolver > Proxies de API na barra de navegação do lado esquerdo.
  3. Clique em + Proxy
  4. Use o assistente Criar proxy para criar um proxy inverso. Consulte o artigo Crie um proxy de API simples.
  5. Na página Políticas comuns do assistente, selecione o botão de opção junto a OAuth v2.0.
1 proxy de API recém-criado, um para validar os tokens de acesso e outro para remover o token de acesso depois de ter sido validado.

Tenha em atenção que a caixa de verificação Publish API Product fica selecionável e é selecionada automaticamente. Selecione esta opção se quiser gerar automaticamente um produto quando criar o novo proxy de API. O produto gerado automaticamente é criado com uma associação ao novo proxy da API. Se tiver um produto existente ao qual quer associar esta nova API, certifique-se de que desmarca esta caixa de verificação para não criar um produto desnecessário. Para obter informações sobre produtos, consulte o artigo O que é um produto de API?