Como verificar tokens de acesso

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

Confira a documentação da Apigee Edge.

Quando você chama um proxy de API na Apigee que tem segurança do OAuth, a Apigee é responsável por verificar os tokens de acesso. Pense na Apigee como a central de suporte: nenhuma chamada de API pode passar por isso que não tem um token de acesso que pode ser verificado.

Dica: ao verificar um token de acesso, se este erro for exibido para você: "Chamada de API inválida como nenhuma correspondência de apiproduct encontrada", vá para este artigo da comunidade da Apigee para ver detalhes sobre a causa desse erro e as etapas para corrigi-lo.

Como adicionar uma política VerifyAccessToken

Para configurar a verificação de token, coloque uma política OAuthV2 com a operação VerifyAccessToken no início do fluxo do proxy da API (o início do pré-fluxo ProxyEndpoint). Se inseridos, os tokens de acesso serão verificados antes de qualquer outro processamento e, se um token for rejeitado, a Apigee interromperá o processamento e retornará um erro ao cliente.

Para acessar a página de proxies da API usando a IU da Apigee, siga estas etapas:

1. Abra a IU da Apigee.
2. Selecione Develop > API Proxies na barra de navegação à esquerda.
3. Na lista, selecione o proxy que você quer proteger.
4. Na Página de visão geral, clique na guia Desenvolver.
5. No navegador, selecione PreFlow para um endpoint listado em Endpoints do proxy. Normalmente, o endpoint pretendido é chamado de "padrão", mesmo que seja possível criar vários endpoints de proxy. Se você tiver vários endpoints, convém seguir estas etapas para realizar a verificação de token em cada um.
   
   
   
6. No editor de fluxo de proxy, clique em + Etapa.
   
   
   
7. Selecione Nova instância de política.
8. Na lista de políticas, selecione OAuth v2.0.
9. Se quiser, altere o nome da política e o nome de exibição. Por exemplo, para uma melhor legibilidade, é possível alterar o nome de exibição e o nome para "VerifyAccessToken".
10. Clique em Add.

A política padrão já está configurada com a operação VerifyAccessToken. Portanto, você não precisa fazer mais nada:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAuthV2 async="false" continueOnError="false" enabled="true" name="OAuth-v20-1">
    <DisplayName>OAuth v2.0 1</DisplayName>
    <FaultRules/>
    <Properties/>
    <Attributes/>
    <ExternalAuthorization>false</ExternalAuthorization>
    <Operation>VerifyAccessToken</Operation>
    <SupportedGrantTypes/>
    <GenerateResponse enabled="true"/>
    <Tokens/>
</OAuthV2>

Observação: por padrão, o VerifyAccessToken espera que o token de acesso seja enviado em um cabeçalho de autorização como um token do portador. Exemplo:

-H "Authorization: Bearer Rft3dqrs56Blirls56a"

É possível alterar esse padrão no elemento <AccessToken> da política OAuthV2, conforme explicado na documentação da política de OAuthV2.