OAuth 2.0: como configurar um novo proxy de API

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Se você estiver usando a versão do Apigee Cloud do Edge, verá que um proxy chamado oauth está incluído na sua organização por padrão. Esse proxy fornece dois endpoints de amostra para gerar tokens de acesso e de atualização. Se você quiser saber mais sobre os endpoints do token OAuth, consulte Noções básicas sobre os endpoints do OAuth.

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 Edge 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 2.0 a um novo proxy de API

Você pode adicionar facilmente a verificação de OAuth a uma API ao criar um novo proxy de API.

Edge

Para adicionar a verificação OAuth a uma API usando a interface do Edge:

  1. Faça login em apigee.com/edge.
  2. Selecione Desenvolver > 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.

Borda clássica (nuvem privada)

Para adicionar a verificação OAuth a uma API usando a interface clássica do Edge:

  1. Faça login em http://ms-ip:9000, em que ms-ip é o endereço IP ou o nome DNS do nó do servidor de gerenciamento.
  2. Selecione APIs > Proxies de API na barra de navegação superior.
  3. Clique em + Proxy de API.
  4. Use o assistente Criar proxy para criar um proxy reverso. Consulte Criar um proxy de API simples.
  5. Na página Segurança do assistente, selecione o botão de opção ao lado de OAuth v2.0.

Quando você seleciona essa opção, duas políticas são anexadas ao proxy de API recém-criado, uma para verificar os tokens de acesso e outra 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?

Como trabalhar com o proxy OAuth padrão

O proxy oauth expõe o seguinte URI do endpoint:

/oauth/client_credential/accesstoken

Publique esse URI para desenvolvedores que precisam conseguir tokens de acesso. Os desenvolvedores de aplicativos configuram os aplicativos para chamar esse endpoint, apresentando os pares de chave e secret do consumidor para receber tokens de acesso.

O endpoint do token de credenciais do cliente padrão é exposto pela rede no seguinte URL:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

Por exemplo, se o nome da organização for "apimakers", o URL será:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

Esse é o URL que os desenvolvedores chamam para receber tokens de acesso.

Chamar a API

Ao receber um token de acesso, é possível chamar a API com um cabeçalho de autorização e um token do portador, como este:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

Consulte também Como verificar tokens de acesso.