Skip to main content
POST
/
api
/
v1
/
authentication
Autentica usuário e retorna token JWT
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/authentication \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "admin",
  "password": "senha123"
}
'
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huZG9lIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "token_type": "Bearer",
  "expires_in": 300,
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huZG9lIn0.ZXlKaGJHY2lPaUpTVXpJMU5pSXNJbXRwWkdWeWFXRjA",
  "refresh_expires_in": 1800,
  "session_state": "ac79deec-f72f-499d-8543-a57ea8bb5478",
  "scope": "flexdoc-api-scope"
}

Authorizations

​
Authorization
string
header
required

Autentica o acesso a partir de usuário e senha e retorna o Bearer token JWT. Copie o access_token retornado e utilize-o no header Authorization para acessar os endpoints da API.

Body

application/json

Payload para receber as credenciais do usuário para autenticação.

Payload para receber as credenciais do usuário para autenticação.

​
username
string
required

Nome de usuário utilizado para autenticação.

Example:

"admin"

​
password
string
required

Senha correspondente ao usuário informado.

Example:

"senha123"

Response

Bearer Token JWT gerado com sucesso.

Objeto de resposta contendo tokens e informações de sessão.

​
access_token
string

Token de acesso gerado após autenticação.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huZG9lIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

​
token_type
string

Tipo do token de autenticação.

Example:

"Bearer"

​
expires_in
integer<int32>

Tempo em segundos até o token de acesso expirar.

Example:

300

​
refresh_token
string

Token de atualização usado para obter um novo token de acesso.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huZG9lIn0.ZXlKaGJHY2lPaUpTVXpJMU5pSXNJbXRwWkdWeWFXRjA"

​
refresh_expires_in
integer<int32>

Tempo em segundos até o token de atualização expirar.

Example:

1800

​
session_state
string

Identificador único da sessão atual.

Example:

"ac79deec-f72f-499d-8543-a57ea8bb5478"

​
scope
string

Escopo autorizado para este token.

Example:

"flexdoc-api-scope"