POST/api/auth/forgot-password

Nis rivendosjen e një fjalëkalimi: nëse ekziston një llogari me adresën e dhënë të e-mailit, ajo merr një e-mail me një lidhje për rivendosjen.

Dërgoni adresën e e-mailit të llogarisë në fushën `email`. Përgjigja `{"ok":true}` është qëllimisht gjithmonë e njëjta – pavarësisht nëse ekziston një llogari –, që përmes këtij endpoint-i të mos mund të përcaktohet cilat adresa janë të regjistruara. Fjalëkalimi i ri vendoset më pas me token-in nga e-maili përmes `POST /api/auth/reset-password`. Nëse fusha `email` mungon ose është bosh, endpoint-i përgjigjet me 400 `VALIDATION_ERROR`. Për mbrojtje nga abuzimi, numri i kërkesave për IP është i kufizuar (429 `RATE_LIMIT_EXCEEDED`).

Përmbledhje

Thirrja: POST /api/auth/forgot-password. Ky endpoint i përket grupit “Vërtetimi” të API-së së Zentor App. Është i aksesueshëm publikisht dhe nuk kërkon autentifikim. Thirrja është idempotente: thirrjet e përsëritura me të njëjtat të dhëna kthejnë të njëjtin rezultat. Parametrat e detyrueshëm: email (body). Rastet e dokumentuara të gabimeve: 400 VALIDATION_ERROR. Përgjigjja shembull më poshtë tregon strukturën e një përgjigjeje të suksesshme në formatin JSON.

Autentifikimi dhe siguria

Nuk kërkohet autentifikim

Idempotent: Po

Parametrat

email(body, string, i detyrueshëm)— Adresa e e-mailit të llogarisë

Shembull request-i

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

Shembull response-i

{"ok":true}

Kodet e gabimeve

400 VALIDATION_ERROR — Fusha `email` mungon ose është bosh.

Sjellja e verifikuar

Përgjigja është 200 `{"ok":true}`, pavarësisht nëse ekziston llogaria; një fushë email-i që mungon kthen 400 `VALIDATION_ERROR`.

Vërtetimi

Artikuj të lidhur

← Vërtetimi