Pular para o conteúdo principal

Solicitação de Recuperação de Senha

POST /sendRecovery

HTTP
POST /sendRecovery HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json

Endpoint para solicitar a recuperação de senha do usuário. Envia um email com um token de recuperação válido por 24 horas para o endereço informado.

Atributos para solicitação de recuperação

CampoTipoDescriçãoObrigatório
emailstringEmail do usuário cadastrado no sistema.
applicationstringAplicação de origem, valores válidos são "ECOMMERCE", "PARCEIRO" ou "BACKOFFICE".

Requisição

Body
{
"email": "usuaria@vileve.com.br",
"application": "ECOMMERCE"
}

Resposta

200
{
"success": true,
"message": "Email de recuperação enviado. Verifique sua caixa de entrada."
}

Resposta de Sucesso

CampoTipoDescriçãoObrigatório
successbooleanIndica se a operação foi bem-sucedida, sempre true em caso de sucesso.
messagestringMensagem de confirmação do envio do email de recuperação.

Errors

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Campos obrigatórios ausentes ou inválidos.
404NOT FOUNDEmail não encontrado no sistema para a aplicação especificada.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição. Email mal formatado ou aplicação inválida.
429TOO MANY REQUESTSMuitas tentativas de recuperação. Aguarde antes de fazer uma nova solicitação.
500INTERNAL SERVER ERRORErro interno do servidor.

Importante

Segurança

  • Por motivos de segurança, o sistema sempre retorna sucesso, mesmo se o email não existir
  • Isso evita que atacantes descubram quais emails estão cadastrados no sistema
  • O email só será enviado se o usuário realmente existir na aplicação especificada

Token de Recuperação

  • O token gerado é válido por 24 horas
  • Cada nova solicitação invalida tokens anteriores do mesmo usuário
  • O token é enviado através de um link no email de recuperação

Email de Recuperação

  • Contém um link direto para redefinição de senha
  • Inclui instruções claras sobre o processo
  • O link redireciona para a interface da aplicação correspondente

Aplicações Suportadas

  • ECOMMERCE: Portal de vendas online
  • PARCEIRO: Sistema de parceiros
  • BACKOFFICE: Sistema administrativo interno

Fluxo Completo

  1. Usuário solicita recuperação através deste endpoint
  2. Sistema gera token seguro e envia email
  3. Usuário clica no link recebido por email
  4. Usuário define nova senha através do endpoint /passwordReset
  5. Sistema confirma alteração e invalida todos os tokens

Limitação de Tentativas

Para evitar spam, existe um limite de tentativas por IP/usuário. Se excedido, aguarde alguns minutos antes de tentar novamente.