Сессия и пользователи тема 6 из 27

Профиль пользователя

Группа /api/user — личный кабинет вошедшего пользователя: чтение и сохранение профиля, смена пароля, удаление аккаунта. Все методы только для вошедших: гость получает 401 (см. ниже). Идентификатор сессии, полученный при входе (Авторизация и регистрация), передаётся заголовком X-Session-Id.

в этой теме 5
  1. Методы профиля пользователя
  2. Единый 401 для гостя
  3. Сценарий личного кабинета
  4. Где настраивается профиль
  5. Что почитать после профиля

Методы профиля пользователя

МетодАдресКто вызываетНачинает сессию
Текущий пользовательGET /api/userвошедшийнет
Сохранение профиляPOST /api/userвошедшийнет
Смена пароляPOST /api/user/changePasswordвошедшийнет
Удаление аккаунтаDELETE /api/userвошедшийнет
Подтверждение удаления кодом из SMSPOST /api/user/confirmDeletingвошедшийнет

Единый 401 для гостя

Запрос без сессии или с неизвестной сессией:

bash
curl -i "https://example.ru/api/user"
ответ
HTTP/1.1 401 Unauthorized
json
{
    "success": false,
    "error": "Требуется авторизация"
}

Проверка выполняется до разбора параметров: гость получает 401, а не 400 за пропущенный параметр. Витрина смотрит на статус 401 и показывает форму входа.

Сценарий личного кабинета

  1. После входа (POST /api/auth/login) витрина вызывает GET /api/user с X-Session-Id и показывает шапку и профиль.
  2. Форма профиля отправляет POST /api/user: поля на верхнем уровне тела, имена как в data ответа GET /api/user.
  3. Смена пароля — POST /api/user/changePassword с oldPassword и newPassword.
  4. Удаление аккаунта — DELETE /api/user (при включённом подтверждении — ещё POST /api/user/confirmDeleting).

Чтение профиля

bash
curl "https://example.ru/api/user" -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ"
json
{
    "data": {
        "id": 12,
        "login": "user@example.ru",
        "name": "Иван",
        "lastName": "Иванов",
        "email": "user@example.ru",
        "phoneNumber": "+79000000000",
        "personalBirthday": "01.01.1990",
        "emailConfirmed": true
    }
}

Набор полей задаётся в настройках, в примере — типичный.

Сохранение профиля

bash
curl -X POST "https://example.ru/api/user" \
  -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ" \
  -H "Content-Type: application/json" \
  -d '{"name": "Иван", "lastName": "Иванов"}'

В ответе тот же data с профилем. Принимаются только поля из настроек, остальные отбрасываются. Ошибка сохранения Битрикса приходит в errors со статусом 200.

Смена пароля

json
{ "oldPassword": "OldPassw0rd!", "newPassword": "NewPassw0rd!" }

Ответ — {"success": true}, сессия не меняется. Ошибки: 400 — старый пароль неверен или новый нарушает политику паролей групп пользователя (в error текст политики Битрикса); 429 — пять неверных старых паролей за 15 минут (в тексте время до повтора).

Удаление аккаунта

Поведение зависит от опции «Подтверждать удаление аккаунта кодом из SMS»:

  • опция выключена или у пользователя нет телефона: DELETE /api/user сразу помечает аккаунт удалённым (логин, e-mail и телефон освобождаются, сессия закрывается), ответ {"success": true};
  • опция включена: отправляется код по SMS, в data — signedData и sms (retryAfter, attemptsLeft). Витрина просит ввести код и вызывает POST /api/user/confirmDeleting с code (6 цифр) и signedData; ответ {"success": true}.

Ошибки: 403 — пользователь входит в группу администраторов; 404 — пользователя уже нет в базе. Ошибки подтверждения приходят со статусом 200 в errors[0].code: ERR_SIGNATURE и ERR_PARAMS (signedData неверен или чужой), ERR_CONFIRM_CODE. Лимит SMS общий со входом: при превышении статус 429, errors[0].code = sms_limit (формат — в теме Авторизация и регистрация).

Где настраивается профиль

Настройки модуля -> вкладка «Пользователи»:

ОпцияНа что влияет
«Поля, которые отдаёт профиль (GET /api/user)»состав data в GET и POST /api/user и в ответах входа
«Поля, которые пользователь может менять в профиле»какие поля принимает POST /api/user
«Подтверждать удаление аккаунта кодом из SMS»двухшаговое удаление аккаунта

Служебные поля (пароль, контрольная строка и подобные) отбрасываются всегда и в списках выбора показаны серыми.

Что почитать после профиля

Подключим BIK.REST-API к вашему сайту

Оставьте заявку — установим и настроим модуль, ответим на вопросы по API.

c заботой о вас, мы используем cookie на своем сайте, чтобы интернет был чистым и прекрасным