Методы профиля пользователя
| Метод | Адрес | Кто вызывает | Начинает сессию |
|---|---|---|---|
| Текущий пользователь | GET /api/user | вошедший | нет |
| Сохранение профиля | POST /api/user | вошедший | нет |
| Смена пароля | POST /api/user/changePassword | вошедший | нет |
| Удаление аккаунта | DELETE /api/user | вошедший | нет |
| Подтверждение удаления кодом из SMS | POST /api/user/confirmDeleting | вошедший | нет |
Единый 401 для гостя
Запрос без сессии или с неизвестной сессией:
curl -i "https://example.ru/api/user" HTTP/1.1 401 Unauthorized {
"success": false,
"error": "Требуется авторизация"
} Проверка выполняется до разбора параметров: гость получает 401, а не 400 за пропущенный параметр. Витрина смотрит на статус 401 и показывает форму входа.
Сценарий личного кабинета
- После входа (
POST /api/auth/login) витрина вызываетGET /api/userсX-Session-Idи показывает шапку и профиль. - Форма профиля отправляет
POST /api/user: поля на верхнем уровне тела, имена как вdataответаGET /api/user. - Смена пароля —
POST /api/user/changePasswordсoldPasswordиnewPassword. - Удаление аккаунта —
DELETE /api/user(при включённом подтверждении — ещёPOST /api/user/confirmDeleting).
Чтение профиля
curl "https://example.ru/api/user" -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ" {
"data": {
"id": 12,
"login": "user@example.ru",
"name": "Иван",
"lastName": "Иванов",
"email": "user@example.ru",
"phoneNumber": "+79000000000",
"personalBirthday": "01.01.1990",
"emailConfirmed": true
}
} Набор полей задаётся в настройках, в примере — типичный.
Сохранение профиля
curl -X POST "https://example.ru/api/user" \
-H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ" \
-H "Content-Type: application/json" \
-d '{"name": "Иван", "lastName": "Иванов"}' В ответе тот же data с профилем. Принимаются только поля из настроек, остальные отбрасываются. Ошибка сохранения Битрикса приходит в errors со статусом 200.
Смена пароля
{ "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» | двухшаговое удаление аккаунта |
Служебные поля (пароль, контрольная строка и подобные) отбрасываются всегда и в списках выбора показаны серыми.
Что почитать после профиля
- Авторизация и регистрация
- Профили покупателя: сохранённые профили плательщика, счёт, купоны.
- Сессия и авторизация