Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

При отправке этого запроса на сервер, генерируется email сообщение пользователю, с инструкцией по изменению пароля.

Запрос:

URL:

POST https://api.url/v2.1/password_reset_request

Заголовки:

Content-Type - должен быть либо application/x-www-form-urlencoded либо multipart/form-data.

Данные запроса:

Описание данных необходимых (обязательно должны быть указаны) в запросе на смену пароля пользователя:

Параметры запроса:

ИмяТипЗначение по умолчаниюОписание
client_idint
Идентификатор клиента, тот же что и в авторизации
client_secretstring

Секретный ключ клиента, тот же что и в авторизации

emailstring
email пользователя
loginstring
логин пользователя для которого запрашивается смена пароля.
langstring

Язык письма для сброса пароля.

В текущий момент поддерживаются: ru (Русский), en (Английский).

Язык должен передаваться в формате BCP 47.

Не обязательное поле, если не указано (или передан не поддерживаемый язык) будет использоваться заголовок запроса Accept-Language.

Если заголовок отсутствует то будет использоваться русский язык.

Ответ:

       В случае если сервер принял запрос, он отсылает ответ со статусом 202, с пустым телом ответа. В заголовке Location будет содержаться ссылка на запрос смены пароля.

Коды ответов:

202 Accepted - Сервер принял запрос, пользователю было отправлено письмо с инструкцией, но смены пароля пока не было.

400 Bad Request - Переданы неподдерживаемые или неверные параметры, либо сервер не понял запрос (описание ошибки в теле ответа).

403 Forbidden - Указан неверный client_id/client_secret, либо из данного приложения запрещено делать сброс пароля.

404 Not Found - Пользователь с таким email не найден.

409 Conflict - указанный email принадлежит нескольким пользователям.

Также возможны другие ошибки.

Пример

POST https://api.url/v2.1/password_reset_request HTTP/1.1
Content-Type: application/x-www-form-urlencoded
client_id=1&client_secret=my_sercret&email=example@some_mail_domain.ru&login=demo

HTTP/1.1 202 Accepted

Пример, запрос на сброс пароля с письмом на английском:

POST https://api.url/v2.1/password_reset_request HTTP/1.1
Content-Type: application/x-www-form-urlencoded
client_id=1&client_secret=my_sercret&email=example@some_mail_domain.ru&login=demo&lang=en

HTTP/1.1 202 Accepted





  • No labels