VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Autenticação

Recuperação de senha

Pede o e-mail de redefinição e define a senha nova com o token recebido.

A recuperação tem dois passos. Primeiro o usuário informa quem é e a loja envia um e-mail com um link. O link contém um token de uso único, que vale 24 horas; o segundo passo troca esse token pela senha nova. Redefinir a senha derruba todas as sessões da conta (todos os aparelhos precisam logar de novo).

Pedir o e-mail

POST/api/v1/auth/forgot-passwordPública

Pedir o e-mail de redefinição de senha

A resposta é sempre a mesma (200), exista a conta ou não, para ninguém descobrir quais e-mails estão cadastrados. Aceita e-mail, CPF ou CNPJ; um CNPJ compartilhado por mais de uma conta é ignorado em silêncio. O e-mail só sai se a loja tem o envio de e-mails ativo.

Corpo da requisição

identifierstring
E-mail, CPF ou CNPJ da conta. Tem prioridade sobre email.
emailstring
Campo antigo, equivalente a identifier.
panelstring
adminvendor
Painel de onde o pedido saiu. Define para qual tela de login o link do e-mail leva de volta. Omitido: conta de cliente.
bash
curl -X POST "$BASE_URL/api/v1/auth/forgot-password" \
  -H "Content-Type: application/json" \
  -d '{"identifier":"maria.souza@example.com"}'
200Pedido aceito
json
{ "message": "if the email exists, a reset link has been sent" }

Erros do pedido

StatusQuandoCorpo
400Corpo que não é JSON{"error":"invalid request body","detail":"..."}
403reCAPTCHA ausente ou reprovado (se ativo na loja){"error":"captcha_required","detail":"reCAPTCHA token is required"}
429Mais de 3 pedidos por minuto do mesmo IP{"error":"rate limit exceeded",...}

Definir a senha nova

POST/api/v1/auth/reset-passwordPública

Definir a senha nova com o token do e-mail

O token é o do link recebido por e-mail (parâmetro do endereço). Cada token só funciona uma vez.

Corpo da requisição

tokenstringobrigatório
Token do link de redefinição.
new_passwordstringobrigatório
Senha nova: mínimo de 10 caracteres, com maiúscula, minúscula, dígito e símbolo.
bash
curl -X POST "$BASE_URL/api/v1/auth/reset-password" \
  -H "Content-Type: application/json" \
  -d '{"token":"'"$RESET_TOKEN"'","new_password":"NovaSenha#2026"}'
200Senha alterada
json
{ "message": "password reset successful" }

Erros da redefinição

StatusQuandoCorpo
400Faltou token ou new_password{"error":"token and new_password are required"}
400Token desconhecido ou já usado{"error":"invalid or expired reset token"}
400Token vencido (mais de 24 horas){"error":"reset token has expired"}
400Senha fraca{"error":"password_too_weak"}
429Mais de 3 chamadas por minuto do mesmo IP{"error":"rate limit exceeded",...}
Depois de redefinir

Depois de redefinir, mande o usuário para o login. A API não loga a pessoa automaticamente ao redefinir a senha.

Contas de empresas (B2B)

Lojas B2B podem oferecer recuperação por código de 6 dígitos. Veja Recuperação B2B; ela termina nesta mesma rota reset-password.

Veja também

  • Login e segundo fator
  • Renovar e encerrar a sessão
Anterior
Renovar e encerrar a sessão
Próxima
Verificação de e-mail
Nesta página
  • Pedir o e-mail
  • Erros do pedido
  • Definir a senha nova
  • Erros da redefinição
  • Veja também