Breadcrumbs

Запрос на сброс пароля

Метод используется для сброса пароля пользователя к Панели управления Клиента. В результате платформа отправляет на указанный email уведомление с ссылкой и одноразовым токеном, который нужно использовать для вызова метода Валидация токена для сброса пароля.

Для успешного запроса должны выполняться все следующие условия:

  • Глобальный статус пользователя Активный (см. ).

  • Email пользователя подтвержден.

POST {reseller_domain}/internal_api/recovery_password

В этой статье:

Авторизация

Авторизация не требуется.

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

reseller_domain

path

string

Обязательный

Доменное имя реселлера

email

form

string

Опциональный

Email пользователя, который используется как логин для входа в Панель управления Клиента

Модель ответа

Метод возвращает информацию о найденном пользователе, который запрашивает сброс пароля. Модель ответа аналогична методу Быстрая регистрация.

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

Bash
curl --location --request POST 'https://test.activeplatform.com/internal_api/recovery_password' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--data-raw '{
    "data": {
        "attributes": {
            "email": "user@example.com"
        }
    }
}'

Пример ответа

JSON
{
    "data": {
        "id": "2477",
        "type": "users",
        "attributes": {
            "first_name": "Fadel",
            "last_name": "Parisian",
            "middle_name": "",
            "email": "user@example.com"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}