OAuth 2.0: como configurar um novo proxy de API

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

O tipo de concessão de credenciais do cliente define um procedimento para emitir tokens de acesso em troca de credenciais do aplicativo. Essas credenciais de app são o par de chave e secret que o Apigee emite para cada aplicativo registrado em uma organização. Para mais detalhes, consulte Como implementar o tipo de concessão do código de autorização.

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

É possível adicionar a verificação OAuth a uma API ao criar um novo proxy de API na IU da Apigee.

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

Apigee no console do Cloud

  1. No console do Google Cloud , acesse a página Desenvolvimento de proxy > Proxies de API.

    Acessar proxies de API

  2. Selecione sua organização no seletor de projetos no painel Google Cloud . O nome da organização é o mesmo que o nome do seu projeto Google Cloud .
  3. No painel Proxy de API, clique em + Criar.
  4. No painel Criar um proxy, em Modelo de proxy, selecione Proxy reverso (mais comum).
  5. Configure o proxy com o seguinte:
    Nome Valor
    Proxy Name helloworld_oauth2
    Base Path

    /hellooauth2

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

    https://mocktarget.apigee.net/ip

    Isso define o URL de destino que a Apigee invoca em uma solicitação ao proxy de API. Esse destino retorna apenas uma resposta simples: Hello, Guest!.
  6. Clique em Próxima.
  7. Implantar (opcional):
    • Ambientes de implantação: opcional. Use as caixas de seleção para escolher um ou mais ambientes em que o proxy vai ser implantado. Se preferir não implantar o proxy neste ponto, deixe o campo Ambientes de implantação em branco. O proxy poderá ser implantado posteriormente.
    • Conta de serviço: opcional Anexe uma conta de serviço à implantação para permitir que seu proxy acesse os serviços do Google Cloud, conforme especificado no papel e nas permissões da conta de serviço.
  8. Clique em Criar.
  9. No painel Resumo do proxy do proxy helloworld_apikey, clique na guia Desenvolver.
  10. No menu Políticas, clique em Adicionar política.
  11. No painel Criar política, em Segurança, selecione Verificar chave de API.
  12. No painel Verificar chave de API, preencha os campos obrigatórios nas seções Nome e Nome de exibição usando os seguintes valores:
    • Nome: insira um nome para a política. Por exemplo, VerifyAPIKey.
    • Nome de exibição: insira o nome da política para uso na UI. 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 seções Nome e Nome de exibição usando os seguintes valores:
    • Nome: insira um nome para a política. Por exemplo, AssignMessage.
    • Nome de exibição: insira o nome da política para uso na UI. Por exemplo, Assign Message.
  17. Clique em Criar.

  18. Atualize o conteúdo da política Atribuir mensagem 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 Endpoints de proxy, clique em Pré-fluxo.
    2. No painel Solicitação do editor visual, clique em Adicionar etapa de política.
    3. No painel Adicionar etapa de política, selecione Verificar chave de API.
    4. Clique em Adicionar.
    5. No painel Solicitação do editor visual, clique em Adicionar etapa de política.
    6. No painel Adicionar etapa de política, selecione Remover autorização de cabeçalho.
    7. Clique em Adicionar.
  20. Clique em Salvar.

IU clássica

  1. Faça login na IU da Apigee.
  2. Selecione Desenvolvedor → Proxies de API na barra de navegação esquerda.
  3. Clique em + Proxy.
  4. Use o assistente Criar proxy para criar um proxy reverso. Consulte Criar um proxy de API simples.
  5. Na página Políticas comuns do assistente, selecione o botão de opção ao lado de OAuth v2.0.
1 proxy de API recém-criado, um para verificar os tokens de acesso e outro para remover o token de acesso após a verificação.

Observe que a caixa de seleção Produto da API Publish torna-se selecionável e marcada automaticamente. Marque essa opção se quiser gerar um produto automaticamente ao criar o novo proxy de API. O produto gerado automaticamente será criado com uma associação ao novo proxy de API. Se você tiver um produto atual ao qual quer associar essa nova API, desmarque essa caixa de seleção para não criar um produto desnecessário. Para informações sobre produtos, consulte O que é um produto de API?