88API88API
AI-приложенияAPIПомощь и поддержка

Модуль аутентификации электронной почты

Описание функции

Префикс интерфейса унифицирован как http(s)://<your-domain>

В производственных средах следует использовать HTTPS, чтобы гарантировать токены аутентификации. HTTP рекомендуется только для сред разработки.

Внедрите функции проверки электронной почты и сброса пароля, а также интегрируйте ограничение тока и защиту турникета. Поддерживает автоматическое создание случайных паролей и настройку шаблонов электронной почты. Он широко используется в таких сценариях, как регистрация пользователей и привязка учетной записи.

🔐 Аутентификация не требуется

Отправить письмо с подтверждением по электронной почте

  • Имя интерфейса: отправить письмо с подтверждением по электронной почте.
  • Метод HTTP: GET
  • Путь: /api/verification
  • Требования к аутентификации: общедоступно (текущий предел).
  • Введение в функцию: отправьте код подтверждения по электронной почте на указанный адрес электронной почты для привязки электронной почты или операций проверки.

💡Пример запроса:

const response = await fetch(`/api/verification?email=${email}&turnstile=${turnstileToken}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Пример успешного ответа:

{
  "success": true,
  "message": ""
}

❗ Пример реакции на ошибку:

{
  "success": false,
  "message": "Неверный параметр"
}

🧾 Описание поля:

  • email (строка): адрес электронной почты для получения кода подтверждения должен быть в допустимом формате электронной почты.
  • email (строка): токен проверки турникета, используемый для предотвращения атак ботов.

Отправить письмо для сброса пароля

  • Имя интерфейса: отправить электронное письмо для сброса пароля.
  • Метод HTTP: GET
  • Путь: email
  • Требования к аутентификации: общедоступно (текущий предел).
  • Введение в функцию: отправьте ссылку для сброса пароля на зарегистрированный адрес электронной почты, чтобы пользователи могли восстановить свои пароли.

💡Пример запроса:

const response = await fetch(`/api/reset_password?email=${email}&turnstile=${turnstileToken}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Пример успешного ответа:

{
  "success": true,
  "message": ""
}

❗ Пример реакции на ошибку:

{
  "success": false,
  "message": "Этот адрес электронной почты не зарегистрирован"
}

🧾 Описание поля:

  • email (строка): адрес электронной почты, для которого необходимо сбросить пароль, должен быть зарегистрированным адресом электронной почты.
  • email (строка): токен проверки турникета, используемый для предотвращения вредоносных запросов.

Отправьте запрос на сброс пароля

  • Имя интерфейса: отправьте запрос на сброс пароля.
  • Метод HTTP: POST
  • Путь: email
  • Требования аутентификации: общедоступно.
  • Введение в функцию: полный сброс пароля с помощью ссылки сброса в электронном письме, система сгенерирует новый пароль и вернет его.

💡Пример запроса:

const response = await fetch('/api/user/reset', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: "user@example.com",
    token: "verification_token_from_email"
  })
});
const data = await response.json();

✅ Пример успешного ответа:

{
  "success": true,
  "message": "",
  "data": "newPassword123"
}

❗ Пример реакции на ошибку:

{
  "success": false,
  "message": "Ссылка для сброса незаконна или срок ее действия истек."
}

🧾 Описание поля:

  • email (строка): адрес электронной почты для сброса пароля.
  • email (строка): токен аутентификации, полученный из электронной почты сброса.
  • email (строка): в случае успеха возвращается новый пароль, система автоматически генерирует 12-значный случайный пароль.