Endpoint: Login
Este endpoint é usado para autenticar um usuário e obter um token de acesso.
Requisição
POST /auth/login
Parâmetros de entrada
| Parâmetro | Tipo | Descrição |
|---|---|---|
| string | O email do usuário | |
| password | string | A senha do usuário |
Exemplo de Requisição
POST /auth/login HTTP/1.1
Host: dev.solubot.com.br
Content-Type: application/json
{
"email": "example@example.com",
"password": "example123"
}
Resposta de Sucesso
HTTP/1.1 200 OK
Content-Type: application/json
{
"token": "<token de gestão>",
"user":{
"id": "<id do usuário>",
"name": "<nome do usuário>",
"email": "<email do usuário>",
"profile": "<perfil do usuário>"
}
}
Resposta de Erro
Em caso de falha na requisição, serão retornados códigos de status diferentes de 200. A resposta de erro pode conter informações adicionais no corpo da resposta.
Exemplo de resposta de erro:
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"error": "ERR_INVALID_CREDENTIALS"
}
HTTP/1.1 400 Bad Request
Content-Type: application/json
Fluxo de Autenticação
- O cliente envia uma requisição POST para
/auth/logincom as credenciais do usuário (email e senha) no corpo da requisição. - O servidor processa a requisição e verifica as credenciais.
- Se as credenciais forem válidas, o servidor retorna um código de status 200 OK e um token de autorização no corpo da resposta.
- O cliente armazena o token de autorização para uso em requisições futuras.
- Caso as credenciais sejam inválidas ou ocorra algum erro, o servidor retorna um código de status apropriado junto com uma mensagem de erro no corpo da resposta.