API - Obter token

O Access_token obtido através desse processo é necessário para consumo dos endpoints descritos em: Swagger UI

índice:

1 Informações gerais da requisição:
- 1.1 Retorno esperado:
2 Informações adicionais:
3 Parâmetros e autorização:
4 Guia explicativo utilizando plataforma Postman:
- 4.1 Variáveis na plataforma:
- 4.2 params:
- 4.3 Autorization:

Informações gerais da requisição:

Método: POST

URL utilizada: https://dpo.privacytools.com.br/external_api_v2/oauth/token

URL de homologação: https://demo.privacytools.com.br/external_api_v2/oauth/token

Retorno esperado:

Status: 200 OK

Body:

{
    "access_token": "aSkTy3U2*************",
    "token_type": "bearer",
    "refresh_token": "6NO5mvr**************",
    "expires_in": 33476,
    "scope": "password"
}

Informações adicionais:

No consumo de outras APIs é utilizado o “access_token” como token da requisição, utilizando o “token_type” como prefixo do header.

Exemplo: ”bearer aSkTy3U2*************“

O campoexpires_in indica o tempo de expiração do access_token, após o tempo de expiração será necessario gerar um novo token para que não haja interrupção do consumo. Esse novo token é gerado consumindo novamente a API de obter token, com as mesmas variáveis utilizadas anteriormente.

Para evitar casos de erro de autorização nas requisições (erro: 401), nós recomendamos que antes de qualquer consumo de outros endpoints seja feito o consumo da /oauth/token. Assim é sempre garantido que o access_token não estará expirado em uma chamada.

Parâmetros e autorização:

Abaixo estão os parâmetros para consumo:

Query Params:	Authorization:
username > public key	username > client-id
password > secret	password > client-secret
grant_type > scope

tipo de autorização: Basic Auth

Você também pode consumir o curl que é informado no campo “Autorização de token de curl”, para obter o mesmo resultado dessa requisição.

Guia explicativo utilizando plataforma Postman:

Variáveis na plataforma:

Utilize as variáveis criadas junto ao usuario de API, para realizar essa requisição:

params:

Na aba de parâmetros, utilize a seguinte relação, utilizando os dados das suas variáveis:

Key	Valores
username	public key
password	secret
grant_type	scope

Autorization:

Realize a mesma ação do passo acima com os seguintes itens:

Key	Valores
username	client-id
password	client-secret

Prazo de expiração: É possível realizar a configuração do prazo de expiração.

Documentação