POST/api/auth/forgot-password

Запускає скидання пароля: якщо акаунт із вказаним email існує, на нього надходить лист із посиланням для скидання.

Надішліть email акаунта в полі `email`. Відповідь `{"ok":true}` навмисно завжди однакова — незалежно від того, чи існує акаунт, — щоб через цей кінцевий пункт не можна було визначити, які адреси зареєстровано. Новий пароль потім встановлюється за допомогою токена з листа через `POST /api/auth/reset-password`. Якщо поле `email` відсутнє або порожнє, кінцевий пункт відповідає кодом 400 `VALIDATION_ERROR`. Для захисту від зловживань кількість запитів на одну IP-адресу обмежено (429 `RATE_LIMIT_EXCEEDED`).

Огляд

Виклик: POST /api/auth/forgot-password. Цей ендпоінт належить до групи «Автентифікація» API Zentor App. Він загальнодоступний і не потребує автентифікації. Виклик ідемпотентний: повторні виклики з тими самими даними повертають той самий результат. Обов’язкові параметри: email (тіло). Задокументовані випадки помилок: 400 VALIDATION_ERROR. Приклад відповіді нижче показує структуру успішної відповіді у форматі JSON.

Автентифікація та захист

Автентифікація не потрібна

Ідемпотентний: Так

Параметри

email(body, string, обов'язково)— Email акаунта

Приклад запиту

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

Приклад відповіді

{"ok":true}

Коди помилок

400 VALIDATION_ERROR — Поле `email` відсутнє або порожнє.

Перевірена поведінка

Відповідь — 200 `{"ok":true}`, незалежно від того, чи існує акаунт; відсутнє поле email повертає 400 `VALIDATION_ERROR`.

Автентифікація

Споріднені статті

← Автентифікація