1. Домой
  2. Документация
  3. Loyalty
  4. Описание API личного кабинета

Описание API личного кабинета

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

Аутентификация

Для аутентификации запросов используется JWT (json web token) — реализация аутентификации по токену (HTTP Bearer token). Для выполнения запросов, требующих аутентификацию, нужно передать токен в http заголовке Authorization. Например:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaWQiOiIyNjViN2VmMi0zZWYzLTRlZWYtYTRiNi05OWJmMzI0MDY0YmIiLCJleHAiOjE1NTg2ODExOTEsImlzcyI6IlBlcnNvbmFsQXJlYSIsImF1ZCI6IlBlcnNvbmFsQXJlYUNsaWVudCJ9.D0FkWDv5eCeQLJ64L_uXldex5WQf02JgPWr9Z1pif70

Для получения токена аутентификации необходимо вызвать метод user/auth

Ошибки

Если в процессе обработки запроса произойдет ошибка, API вернет объект ошибки и стандартный HTTP-код.

HTTP-коды, используемые в API

200 — Успешный запрос.
400 — Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API.
401 — Неверный токен доступа или отсутствует заголовок Authorization.
500 — На стороне сервиса что-то пошло не так. Результат обработки запроса неизвестен. Обратитесь к системному администратору.

Коды ошибок бизнес логики

"phone_or_email_required" - поля телефон или email обязательные для заполнения
"user_already_exists" - пользователь уже существует
"user_not_found" - пользователь не найден
"invalid_password - неправильный пароль
"invalid_token" - некорректный токен авторизации
"registration_already_confirmed" - регистрация уже подтверждена

Методы

  • user/register — регистрация пользователя
  • user/registerConfirm — подтверждение регистрации
  • user/auth — аутентификация пользователя
  • profile/info — получение данных клиента
  • profile/edit — редактирование данных клиента
  • purchase/list — получение данных о покупках клиента

Статьи

Материал был полезен? Да Нет