Login

Este documento apresenta os casos de uso da controller Auth da APIs REST IntegraDoor. São descritos os fluxos de autenticação via credenciais de usuário, API Key e renovação de tokens. Todos os métodos retornam tokens compatíveis com o modelo Bearer Token, com tempo de vida de:

• access_token: 15 horas
• refresh_token: 72 horas

---

Login com e-mail e senha

POST /api/v2/auth/login

Autenticação padrão com usuário e senha, com suporte ao segundo fator (2FA).

Exemplo de requisição

{
  "email": "usuario@exemplo.com.br",
  "senha": "senha123"
}

1. Envie email e senha no corpo da requisição.
2. Aguarde o retorno com access_token e refresh_token.
3. Use o token no cabeçalho: Authorization: Bearer.

---

Login com API Key

POST /api/v2/auth/login-by-key

Autenticação automatizada utilizando clientId e clientSecret.

Exemplo de requisição

{
  "clientId": "seu-client-id",
  "clientSecret": "seu-client-secret"
}

1. Solicite sua chave ao administrador IntegraDoor.
2. Envie o par clientId e clientSecret.
3. Receba os tokens e use o access_token nas chamadas seguras.

---

Renovar access_token com refresh_token

POST /api/v2/auth/refresh-token

Gere um novo access_token com um refresh_token ainda válido.

Exemplo de requisição

{
  "refreshToken": "token-de-refresh-aqui"
}

1. Guarde o refresh_token com segurança.
2. Envie o token em uma chamada POST.
3. Receba um novo par de tokens atualizados.

---

Obter informações do 2FA

GET /api/v2/auth/info-2fa/email

Consulta o método de autenticação 2FA antes da realização do login.

1. Verifique se o email está corretamente registrado.
2. Envie uma requisição GET para o endpoint.
3. Veja o telefone mascarado e o tipo de verificação ativa.

---

Alterar senha

POST /api/v2/auth/alterar-senha

Permite ao usuário alterar sua senha de forma segura e autenticada.

Exemplo de requisição

{
  "senhaAtual": "senha_antiga",
  "novaSenha": "nova_senha_segura",
  "confirmarNovaSenha": "nova_senha_segura"
}

1. Faça login e obtenha um access_token.
2. Envie a senha atual e a nova senha no corpo da requisição.
3. Confirme o sucesso da troca pelo retorno da API.

---

Uso do Bearer Token nas requisições

Método padrão de autenticação nas rotas protegidas.

1. Realize login e obtenha um access_token válido.
2. Use o token no header: Authorization: Bearer {access_token}.
3. Quando expirar, renove utilizando o refresh_token.

---

Integração com OAuth2 (compatível)

Embora a API não implemente OAuth2 completo, o fluxo client_credentials é compatível.

1. Configure clientId e clientSecret.
2. Envie um POST para /api/v2/auth/login-by-key.
3. Use o token de resposta como Bearer.