POST/api/auth/forgot-password

Inicia a reposição de uma palavra-passe: se existir uma conta com o e-mail indicado, esta recebe um e-mail com uma hiperligação para a reposição.

Envie o e-mail da conta no campo `email`. A resposta `{"ok":true}` é deliberadamente sempre igual – independentemente de a conta existir ou não – para que este endpoint não permita descobrir que endereços estão registados. A nova palavra-passe é depois definida com o token do e-mail através de `POST /api/auth/reset-password`. Se o campo `email` estiver em falta ou vazio, o endpoint responde com 400 `VALIDATION_ERROR`. Para prevenir abusos, o número de pedidos por endereço IP é limitado (429 `RATE_LIMIT_EXCEEDED`).

Visão geral

Chamada: POST /api/auth/forgot-password. Este endpoint pertence ao grupo «Autenticação» da API da Zentor App. É de acesso público e não requer autenticação. A chamada é idempotente: chamadas repetidas com os mesmos dados devolvem o mesmo resultado. Parâmetros obrigatórios: email (body). Casos de erro documentados: 400 VALIDATION_ERROR. A resposta de exemplo abaixo mostra a estrutura de uma resposta bem-sucedida em formato JSON.

Autenticação e segurança

Não é necessária autenticação

Idempotente: Sim

Parâmetros

email(body, string, obrigatório)— Endereço de e-mail da conta

Pedido de exemplo

{"email":"user@example.com"}

Resposta de exemplo

{"ok":true}

Códigos de erro

400 VALIDATION_ERROR — O campo `email` está em falta ou vazio.

Comportamento verificado

A resposta é 200 `{"ok":true}`, independentemente de a conta existir; um campo de e-mail em falta devolve 400 `VALIDATION_ERROR`.

Autenticação

Artigos relacionados

← Autenticação