Teste de OAuth: como testar e montar uma requisição OAuth no seu ambiente

Para facilitar o entendimento e a utilização do OAuth em seu ambiente, preparamos uma "receita de bolo" prática e rápida utilizando o Postman.

Para seguir nosso passo-a-passo, você já deve estar com o Postman instalado. Além disso, precisará também de uma app cadastrada corretamente com um plano de acesso à API desejada. E, por último, a sua API deve conter um interceptor de OAuth ou JWT (dependendo da estratégia de segurança escolhida) para que o fluxo seja validado nas requisições.

Agora, vamos começar!

Importando o ambiente

A primeira etapa é importar o ambiente (environment) que será utilizado nas chamadas.

Para isso, utilize o JSON abaixo, alterando os seguintes campos, de acordo com o seu ambiente:

  • AMBIENTE: nome do seu ambiente (e.g., "demov3");

  • CLIENT_ID_APP_ACESSO_OAUTH: client ID da app que utilizará o serviço de OAuth;

  • CLIENT_SECRET_APP_ACESSO_OAUTH: client secret da app que utilizará o serviço de OAuth.

{
 "id": "1cbf0033-fd38-8dd5-185c-847953c46490",
 "name": "AMBIENTE",
 "values": [
   {
     "key": "URL",
     "value": "http://apigateway.AMBIENTE.com/oauth",
     "enabled": true,
     "type": "text"
   },
   {
     "key": "CLIENT_ID",
     "value": "CLIENT_ID_APP_ACESSO_OAUTH",
     "enabled": true,
     "type": "text"
   },
   {
     "key": "CLIENT_SECRET",
     "value": "CLIENT_SECRET_APP_ACESSO_OAUTH",
     "enabled": true,
     "type": "text"
   },
   {
     "key": "AUTHORIZATION_KEY",
     "value": "AUTOMÁTICO",
     "enabled": true,
     "type": "text"
   },
   {
     "key": "REFRESH_TOKEN",
     "value": "AUTOMÁTICO",
     "enabled": true,
     "type": "text"
   },
   {
     "key": "CODE",
     "value": "AUTOMÁTICO",
     "enabled": true,
     "type": "text"
   }
 ],
 "_postman_variable_scope": "environment",
 "_postman_exported_at": "2018-04-17T12:09:14.110Z",
 "_postman_exported_using": "Postman/6.0.10"
}

Após salvar o arquivo JSON, utilize a função de importação do Postman.

oauth import collection oauth import

Importando a coleção de chamadas

Para importar a coleção de chamadas (V2), siga os passos:

  1. Faça o download da coleção OAuth 2.0;

  2. Descomprima a pasta "OAUTH2.0.postman_collection.zip";

  3. Abra o Postman e clique no botão Import;

  4. Selecione o arquivo .json salvo e clique em "Open" para importá-lo.

Logo após a importação, você terá uma pasta com todas as requisições, como a mostrada abaixo:

oauth collection

Gerando um code

Para utilizar e testar o fluxo OAuth em seu ambiente, gere um code através do item Grant-code. Você pode encontrar esta requisição na pasta raiz da coleção de requisições criada.

Lembre-se desta requisição, pois você utilizará esta chamada em todos os testes que for realizar.

Finalmente, após executar o Grant-code, você será capaz de gerar o access token que a sua estratégia utilizará (JWT, Authorization Code, Client Credentials, Implicit, Password ou Refresh Token).

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]