Usuários

Endpoint responsável por visualizar usuário, criar usuário, editar usuário e fazer login.

Visualizar Usuário

GET

/users

Cabeçalho

É necessário comprovar autorização com o access_token para realizar essa operação.

Authorization: Bearer access_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_access_token",
  "accept": "application/json"
}

Parâmetros

Sem parâmetros.

Resposta

Valores de Resposta

id string Obrigatório
Idetificador do usuário.

name string Obrigatório
Nome do usuário.

email string Obrigatório
E-mail do usuário.

active boolean Obrigatório
Flag para indicar se usuário está ativo.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

{
  "id": "k8a2cibc-50d7-46c0-9bdf-che3f123bpba",
  "name": "user",
  "email": "user@email.com",
  "active": true
}

Criar Usuário

POST

/users

Cabeçalho

Não é necessário comprovar autorização para realizar essa operação.

Parâmetros

name string Obrigatório
Nome do usuário.

email string Obrigatório
E-mail do usuário.

password string Obrigatório
Senha do usuário.

Exemplo de corpo de requisição

{
  "name": "user",
  "email": "user@email.com",
  "password": "Senha#123"
}

Resposta

Valores de Resposta

id string Obrigatório
Idetificador do usuário.

name string Obrigatório
Nome do usuário.

email string Obrigatório
E-mail do usuário.

active boolean Obrigatório
Flag para indicar se usuário está ativo.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

{
  "id": "k8a2cibc-50d7-46c0-9bdf-che3f123bpba",
  "name": "user",
  "email": "user@email.com",
  "active": false
}

Editar Usuário

PUT

/users

Cabeçalho

É necessário comprovar autorização com o access_token para realizar essa operação.

Authorization: Bearer access_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_access_token",
  "accept": "application/json"
}

Parâmetros

name string Obrigatório
Nome do usuário.

email string Obrigatório
E-mail do usuário.

new_password string Obrigatório
Senha do usuário.

new_password_confirm string Obrigatório
Confirmação da senha do usuário.

Exemplo de corpo de requisição

{
  "name": "user",
  "email": "user@email.com",
  "new_password": "Senha#123",
  "new_password_confirm": "Senha#123"
}

Resposta

Valores de Resposta

id string Obrigatório
Idetificador do usuário.

name string Obrigatório
Nome do usuário.

email string Obrigatório
E-mail do usuário.

active boolean Obrigatório
Flag para indicar se usuário está ativo.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

{
  "id": "k8a2cibc-50d7-46c0-9bdf-che3f123bpba",
  "name": "user",
  "email": "user@email.com",
  "active": true
}

Login

POST

/users/login

Cabeçalho

Não é necessário comprovar autorização para realizar essa operação.

Content-Type: application/json

Exemplo de headers

{
  "Content-Type": "application/json"
}

Parâmetros

username string Obrigatório
E-mail do usuário.

password string Obrigatório
Senha do usuário.

Exemplo de corpo de requisição

{
  "username": "user@email.com",
  "password": "Senha#123"
}

Resposta

Valores de Resposta

refresh_token string Obrigatório
Token do usuário.

token_type string Obrigatório
Tipo de token.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

{
  "refresh_token": "token",
  "token_type": "JWT bearer"
}

O token JWT de resposta está no formato secret base64 encoded.

Recovery

POST

/users/recovery

Cabeçalho

Não é necessário comprovar autorização para realizar essa operação.

Content-Type: application/json

Exemplo de headers

{
  "Content-Type": "application/json"
}

Parâmetros

username string Obrigatório
E-mail do usuário.

Exemplo de corpo de requisição

{
  "username": "user@email.com"
}

Resposta

Valores de Resposta

ok string Obrigatório
Resposta da requisição.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

"ok"

Um e-mail será enviado para o usuário indicado contendo um token de recuperação.

Recovery Password

POST

/users/recovery-password

Cabeçalho

Não é necessário comprovar autorização para realizar essa operação.

Content-Type: application/json

Exemplo de headers

{
  "Content-Type": "application/json"
}

Parâmetros

email string Obrigatório
E-mail do usuário.

recovery_code string Obrigatório
Código de recuperação.

password string Obrigatório
Nova senha do usuário.

password_confirm string Obrigatório
Cofirmação da nova senha do usuário.

Exemplo de corpo de requisição

{
  "email": "user@email.com",
  "recovery_code": "your_recovery_code",
  "password": "your_new_password",
  "password_confirm": "your_new_password",
}

Resposta

Valores de Resposta

string Obrigatório
Resposta da requisição.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

"ok"

Refresh Token

Rota para obter o access_token, utilizado nas requisições da API.

POST

/refresh-token

Cabeçalho

É necessário comprovar autorização com o refresh_token para realizar essa operação.

Authorization: Bearer refresh_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_refresh_token",
  "accept": "application/json"
}

Resposta

Valores de Resposta

access_token string Obrigatório
Access token do usuário.

expires_at string Obrigatório
Data e hora da expiração do access token.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro do cliente
500	Erro do servidor

Exemplo de resposta

{
  "access_token": "token",
  "expires_at": "2024-03-05T11:38:04.699740"
}

note

O access_token tem duração de 1 dia, enquanto, o refresh_token tem duração de 30 dias.