Recuperação de Senha

A recuperação de senha permite que o usuário 👤 restabeleça o acesso à sua conta quando esquecer a senha atual.

O processo consiste na solicitação de um link de redefinição, enviado para o e-mail cadastrado.

Ao acessar esse link, o usuário pode criar uma nova senha com segurança, garantindo que apenas o proprietário da conta consiga restaurar o acesso ao painel.

No contexto da Uappi, existem múltiplas abordagens para a recuperação de senha, incluindo:

• 👤 solicitação realizada por outro administrador
• 📩 solicitação por e-mail
• ⚙️ alteração direta da senha pelo painel Minha Conta

Solicitar Código de Recuperação de Senha

Endpoint

Descrição

Endpoint responsável por iniciar o processo de recuperação de senha, enviando um código único para o e-mail do usuário cadastrado.

O código vale por 60 minutos e um novo pedido invalida o anterior. Usuário humano que ainda não fez login recebe o convite de primeiro acesso; nos demais casos, recebe a recuperação de senha. Usuários de integração também podem usar este endpoint.

Parâmetros de query

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Uso

⚠️ IMPORTANTE: Por segurança 🔐, o sistema retorna data: true mesmo quando o e-mail não está cadastrado.

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

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": true
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Alterar Senha com Código de Recuperação

Descrição

Endpoint responsável por finalizar o processo de recuperação de senha, permitindo que o usuário defina uma nova senha utilizando o código de verificação recebido por e-mail.

Este endpoint deve ser utilizado após a solicitação de recuperação em /auth/users/password-recovery.

O código vale por 60 minutos e é de uso único. Se as senhas informadas forem diferentes, o código não é gasto e pode ser usado de novo. Ao concluir, a senha anterior deixa de valer, inclusive para usuários de integração.

Parâmetros de query

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request PUT \
2  --url {{ MAIN_URL }}/auth/users/password-recovery \
3  --data '{
4    "code": "ABC123XYZ789",
5    "password": "minhaNovaSenha123",
6    "confirmPassword": "minhaNovaSenha123"
7  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": true
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Solicitação de recuperação de senha de usuário por ID

Descrição

Este endpoint permite que um usuário administrador solicite a alteração de senha de outro usuário, informando o ID. Vale para usuários humanos e de integração.

O e-mail enviado depende do usuário:

• Humano que ainda não fez login: recebe o convite de primeiro acesso. Serve para reenviar o convite.
• Humano que já fez login e usuário de integração: recebem o e-mail de recuperação de senha.

O código do e-mail vale por 60 minutos e um novo pedido invalida o anterior. Ao definir a nova senha, a senha anterior deixa de valer.

Parâmetros de query

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/auth/users/{userId}/password-recovery \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": true
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Alteração de senha do usuário autenticado

Descrição

Endpoint que permite que um usuário administrador altere a própria senha enquanto estiver autenticado, por meio da tela de Minha Conta no painel.

Parâmetros de query

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/auth/users/password \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "password": "123456"
6    "confirmPassword":"k23gj32in"
7    "currentPassword":"k23gj32in"
8  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2	"status": true,
3	"data": true
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.