🔐 Autenticação de Usuários

Autenticação é o processo que permite o acesso seguro à plataforma, utilizando credenciais e tokens para identificar o usuário e confirmar sua legitimidade.

A Uappi oferece diferentes métodos de autenticação para o painel administrativo, incluindo login tradicional com e-mail e senha, recursos adicionais de segurança, como Authenticator e MFA, garantindo proteção reforçada e confiabilidade no acesso.

Login de Usuário

Descrição

Endpoint responsável por autenticar usuários e fornecer tokens de acesso para operações protegidas.

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

⚠️ IMPORTANTE: Quando MFA está ativo, o login deve ser finalizado no endpoint de login.

1curl --request POST \
2  --url {{ MAIN_URL }}/auth/users/login \
3  --data '{
4    "email": "usuario@exemplo.com",
5    "password": "minhaSenha123"
6  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
3}

MFA Requerido

⚠️ Não aplicável para usuários de integração

Quando Multi-Factor Authentication (MFA) está habilitado para o usuário, retorna dados necessários para continuidade do fluxo de autenticação:

1{
2  "secretKey": "JBSWY3DPEHPK3PXP",
3  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSU..."
4}

⚠️ Possíveis erros:

O processo de autenticação pode resultar em alguns erros. A seguir, estão listados os principais casos que podem ajudar a identificar e compreender o problema.

Confirmação Multi-Factor Authentication (MFA)

Descrição

Endpoint responsável por finalizar o processo de autenticação quando o Multi-Factor Authentication (MFA) está habilitado, utilizando o código gerado pelo aplicativo autenticador.

Esse endpoint é acionado exclusivamente quando o login inicial retorna informações relacionadas ao MFA, indicando que a segunda etapa de validação é obrigatória.

⚠️ Este contexto não se aplica a usuários de integração, sendo válido apenas para autenticações realizadas via painel ou fluxo interativo.

Parâmetros

Headers Obrigatórios

Parâmetros de Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/auth/users/mfa \
3  --data '{
4    "mfaToken": "abc13523623532",
5    "code": "058590"
6  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
3}

⚠️ Possíveis erros:

O processo de autenticação pode resultar em alguns erros. A seguir, estão listados os principais casos que podem ajudar a identificar e compreender o problema.