Geração do Token de Acesso

Para gerar o Token de Acesso, é necessário realizar uma requisição utilizando HTTP Basic Authentication através de um método POST, de modo que seja enviado um Header Authorization com valor Basic {CODIGO_BASE64}. As credenciais CLIENT_ID e CLIENT_SECRET devem ser concatenadas com um símbolo “:” para que então sejam informadas como valor para o campo citado.

Deve também ser informado o tipo de autenticação no corpo da mensagem como client_credentials. Segue o modelo de requisição utilizado para gerar o token de acesso:

URL AUTH

{BaseUrl}/api/auth/generate_token

HTTP Headers - Exemplo

Authorization: BASIC base_64({CLIENT_ID}:{CLIENT_SECRET})
Content-Type: application/json

HTTP Request Body

{
"grant_type": "client_credentials"
}

Caso os dados informados estejam corretos, será retornada uma mensagem HTTP 200 OK informando o código gerado e o seu tempo de validade. Esse código deverá ser utilizado em todas as requisições posteriores, e precisará ser gerado novamente após atingir seu tempo de expiração.

HTTP 200 Response Body - Exemplo

{
    "access_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2NjUwNjc2MDJ9.ogQs-M3JPH9kgQuqOVc9erv3kBlXr5i2Y7bDFjNh3qI",
    "token_type": "Bearer",
    "expires_in": 1800
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
access_token (Obrigatório)	Token JWT a ser utilizado nas demais requisições da API	STRING
token_type (Obrigatório)	Tipo de token gerado	STRING
expires_in (Obrigatório)	Tempo de validade do token, em segundos	INTEGER

Em caso de das informações passadas na requisição para criação de token serem inválidas, será retornado HTTP 401 Unauthorized, de acordo com o exemplo abaixo.

HTTP 401 Response Body - Exemplo:

{
    "error": "unauthorized"
}