POST/api/auth/forgot-password

Begin die terugstel van 'n wagwoord: as 'n rekening met die opgegewe e-posadres bestaan, ontvang dit 'n e-pos met 'n skakel om terug te stel.

Stuur die e-posadres van die rekening in die veld `email`. Die antwoord `{"ok":true}` is doelbewus altyd dieselfde – ongeag of 'n rekening bestaan – sodat via hierdie eindpunt nie vasgestel kan word welke adresse geregistreer is nie. Die nuwe wagwoord word daarna met die token uit die e-pos via `POST /api/auth/reset-password` ingestel. As die veld `email` ontbreek of leeg is, antwoord die eindpunt met 400 `VALIDATION_ERROR`. Ter beskerming teen misbruik is die aantal versoeke per IP-adres beperk (429 `RATE_LIMIT_EXCEEDED`).

Oorsig

Oproep: POST /api/auth/forgot-password. Hierdie eindpunt behoort tot die groep “Verifikasie” van die Zentor App-API. Dit is publiek toeganklik en vereis geen verifikasie nie. Die oproep is idempotent: herhaalde oproepe met dieselfde insette lewer dieselfde resultaat. Verpligte parameters: email (body). Gedokumenteerde foutgevalle: 400 VALIDATION_ERROR. Die voorbeeldrespons hieronder toon die struktuur van ’n suksesvolle respons in JSON-formaat.

Verifikasie en sekuriteit

Geen verifikasie vereis nie

Idempotent: Ja

Parameters

email(body, string, vereis)— E-posadres van die rekening

Voorbeeldversoek

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

Voorbeeldrespons

{"ok":true}

Foutkodes

400 VALIDATION_ERROR — Die veld `email` ontbreek of is leeg.

Gekontroleerde gedrag

Die antwoord is 200 `{"ok":true}`, ongeag of die rekening bestaan; 'n ontbrekende e-posveld lewer 400 `VALIDATION_ERROR`.

Verifikasie

Verwante artikels

← Verifikasie