POST/api/auth/forgot-password
開始密碼重設:如果存在用嗰個電郵地址嘅帳戶,就會收到一封包含重設連結嘅電郵。
喺`email`欄位傳送帳戶嘅電郵地址。回應`{"ok":true}`係刻意一直保持一致——無論帳戶係否存在——咁樣就唔可以透過呢個端點判斷邊啲地址已經註冊咗。之後用電郵嘅權杖,透過`POST /api/auth/reset-password`設定新密碼。 如果`email`欄位缺失或者係空,端點就會以400 `VALIDATION_ERROR`回應。為防止濫用,每個IP地址嘅請求數量係受限制嘅(429 `RATE_LIMIT_EXCEEDED`)。
概覽
調用:POST /api/auth/forgot-password。此端點屬於 Zentor App API 的「身份驗證」組別。 此端點可公開存取,毋須身份驗證。 此調用屬冪等:以相同輸入重複調用,將傳回相同結果。 必填參數:email (請求主體)。 已記錄的錯誤情況:400 VALIDATION_ERROR。 下方的範例回應展示 JSON 格式成功回應的結構。
身份驗證同安全保障
唔需要身份驗證
冪等: 係
參數
email(body, string,必填)— 帳戶嘅電郵地址請求範例
{"email":"user@example.com"}回應範例
{"ok":true}錯誤代碼
400 VALIDATION_ERROR — `email` 欄位缺失或者係空嘅。已驗證嘅行為
無論帳戶係否存在,回應都係 200 `{"ok":true}`;缺少電郵欄位就會回傳 400 `VALIDATION_ERROR`。