Autenticação

OAuth
Client ID Validation
Authorization Basic
Password
Backend Ellevo

OAuth

Authorization Code

Para consumir as APIs que possuem esse tipo de autenticação, sua aplicação deverá realizar a autenticação de seu APP através do seguinte fluxo:

Passo 1: aplicação solicita a garantia de autorização através do envio do client_id (identificador do APP).
Passo 2: se client_id válido, a aplicação receberá um código representando a autorização concedida.
Passo 3: aplicação solicita um token de acesso através do envio das credenciais do APP solicitante e do código de autorização concedida para este APP.
Passo 4: caso as credenciais sejam válidas e o código de autorização esteja ativo, a aplicação receberá um token de acesso.
Passo 5: aplicação solicita o consumo dos recursos disponíveis nas APIs através do envio do client_id e access_token.
Passo 6: se as autenticações estejam válidas no escopo da requisição, a aplicação receberá o conjunto de informações solicitadas.


Tutorial:

1 – Realizar cadastro no portal .

2 – Criar uma APP no portal , para gerar as credenciais utilizadas no processo de autenticação.



3 – Faça o download do Postman aqui .
Obs.: Você poderá utilizar o software que estiver mais a vontade, mas a título de explanação, o Postman foi o software sugerido por ter uma facilidade maior quanto a configuração e uso.


4 – No Postman procure o botão Manage Environments no canto superior direito.



5 – Clique no botão Importe e selecionte este arquivo .
O Postman irá carregar as configurações das variáveis que serão utilizadas.
6 – Na mesma tela do Manage Environments, clique no botão Globals.

7 – Preencha o client_id e client_secret com as informações da APP criada no passo 2 e salve.



8 – Na tela inicial do Postman clique em Import:

9 – Na tela que irá abrir clique em Upload Files e selecione este arquivo e clique no botão Import.
O Postman irá carregar a collection contendo 3 calls.



Executando a collection:

1 – Abra a call "Obter Grant Code":
  1. clique em Send.

Será retornado um JSON com o código grant_code, o mesmo será preenchido automaticamente nas variáveis globais em “grant_code”.



2 – Abra a call “Obter Access Token”:
  1. clique na aba “Authorization”
  2. selecione em TYPE “Basic Auth”
  3. preencha os campos "Username" e "Password" com as credenciais de seu APP (client_id e client_secret respectivamente)
  4. clique em Send.

Atenção:

Para APIs Monetizadas utilizar o seguinte body para geração de token:


                {  
                  "client_id": "{{client_id}}",
                  "redirect_uri": "http://localhost/",
                  "extraInfo":{
                      "owner": "Centro-Custo"
                  }
                }
                

Será retornado um JSON com o campo access_token, o mesmo será preenchido automaticamente nas variáveis globais em “access_token”.




3 – Para gerar um novo token após sua expiração:
  1. Abra a call “Obter Access Token (refresh)”
  2. clique na aba “Authorization” e preencha os campos "Username" e "Password" com as credenciais de seu APP
  3. clique em Send.

O APP estará autenticado novamente e com acesso para consummir a API , informe no header das requisições.
Português, Brasil