Методы входа и регистрации
| Метод | Адрес | Кто вызывает | Начинает сессию |
|---|---|---|---|
| Вход по логину и паролю | POST /api/auth/login | гость | да |
| Вход по SMS: отправка кода | POST /api/auth/loginByCode | гость | да |
| Подтверждение кода из SMS | POST /api/auth/confirm | гость | да |
| Повторная отправка кода | POST /api/auth/resendCode | гость | да |
| Регистрация по телефону или e-mail | POST /api/auth/register | гость | да |
| Вход через Яндекс ID | POST /api/auth/loginByYandex | гость | да |
| Вход через VK ID | POST /api/auth/loginByVK | гость | да |
| Выход | POST /api/auth/logout | гость и вошедший | да |
| Подтверждение e-mail по ссылке из письма | POST /api/auth/confirmEmail | гость | нет |
| Письмо для восстановления пароля | POST /api/auth/sendPassword | гость | нет |
| Смена пароля по контрольной строке | POST /api/auth/restorePassword | гость | нет |
Параметры передаются в теле запроса (JSON или форма). Профиль вошедшего пользователя отдаёт GET /api/user (Профиль пользователя).
Сценарий: вход по паролю
- Витрина отправляет
POST /api/auth/loginс логином и паролем. - Из заголовка ответа
X-Session-Idберёт идентификатор сессии и сохраняет его. - Следующие запросы (
GET /api/user, корзина, заказы) идут с этим заголовком.
curl -i -X POST "https://example.ru/api/auth/login" \
-H "Content-Type: application/json" \
-d '{"username": "user@example.ru", "password": "secret"}' Ответ при успехе:
HTTP/1.1 200 OK
X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ {
"success": true
} Если Битрикс отказал во входе (неверный логин или пароль, пользователь заблокирован), статус 403, в error его текст:
{
"success": false,
"error": "Неверный логин или пароль."
} Сценарий: вход и регистрация по SMS
POST /api/auth/loginByCodeсphoneNumber(любой формат с кодом страны) отправляет код на номер. Если пользователя с таким номером нет, он регистрируется (как вregister).- В ответе
signedData— подписанная строка; витрина показывает поле для кода. POST /api/auth/confirmсcode(ровно 6 цифр) иsignedDataпроверяет код, подтверждает номер и авторизует пользователя. Вdataприходит профиль.- Кнопка «Отправить код ещё раз» —
POST /api/auth/resendCodeс тем жеphoneNumber.
{
"data": {
"signedData": "подписанная-строка",
"dataSign": "подписанная-строка",
"dateSend": "2026-01-01 12:00:00"
}
} Ответ confirm:
{
"data": {
"id": 12,
"login": "user@example.ru",
"name": "Иван",
"lastName": "Иванов",
"email": "user@example.ru",
"phoneNumber": "+79000000000",
"emailConfirmed": true
}
} Набор полей профиля задаётся в настройках (см. ниже). Ошибки confirm приходят со статусом 200 в errors[0].code: ERR_SIGNATURE и ERR_PARAMS (signedData неверен), ERR_CONFIRM_CODE (код неверен или не 6 цифр), ERR_NOT_FOUND (номер не зарегистрирован). Заблокированному пользователю loginByCode отвечает errors[0].code = ERR_SBLOCKED со статусом 200.
Лимит отправки SMS
Лимит общий для loginByCode, register и resendCode. При превышении статус 429, errors[0].code = sms_limit, в data.sms — retryAfter (через сколько секунд повторить) и attemptsLeft (сколько попыток осталось):
{
"errors": [
{ "message": "текст причины отказа", "code": "sms_limit", "customData": null }
],
"data": {
"sms": { "retryAfter": 60, "attemptsLeft": 0 }
}
} Сценарий: регистрация
POST /api/auth/register принимает phoneNumber или email (нужен хотя бы один, иначе 400), необязательные password (если не передан, пароль генерируется), groupID и дополнительные поля на верхнем уровне тела. По телефону уходит SMS-код, его подтверждает confirm. Ошибка регистрации Битрикса приходит в errors со статусом 200.
{
"data": {
"message": "Вы успешно зарегистрированы.",
"type": "OK",
"id": 12
}
} Сценарий: восстановление пароля
POST /api/auth/sendPasswordсloginиemailотправляет письмо с контрольной строкой.- Страница витрины, куда ведёт ссылка из письма, вызывает
POST /api/auth/restorePasswordсlogin,checkword(строка из письма) и новымpassword. - Результат Битрикса —
type(OKилиERROR) иmessage, статус 200.
Подтверждение e-mail по ссылке из письма — POST /api/auth/confirmEmail с user_id и code: неверный код — статус 200, success: false и текст в error.
Вход через соцсети
loginByYandex и loginByVK принимают готовый токен провайдера ({"token": "..."}), проверяют его и client_id приложения, создают или находят пользователя по ID у провайдера. Витрина получает токен сама (Яндекс ID — из фрагмента адреса возврата, VK ID — через SDK и обмен code на токен); пошаговый порядок — в описании методов в документации API. Ответ — {"success": true, "data": {профиль}} и заголовок X-Session-Id.
Ошибки: 400 — токен не передан; 401 — провайдер отклонил токен или он выдан другому приложению; 403 — вход выключен, не задан client_id или пользователь заблокирован; 502 — сервис провайдера не ответил.
Где настраиваются вход и регистрация
| Что | Где |
|---|---|
Какие поля принимает регистрация, какие группы можно указать в groupID | Настройки модуля -> вкладка «Пользователи» («Поля, которые принимаются при регистрации», «Группы, в которые можно добавить при регистрации») |
| Какие поля профиля приходят в ответах входа | вкладка «Пользователи», «Поля, которые отдаёт профиль» |
| Интервал между отправками кода, число кодов до блокировки, время блокировки, срок хранения журнала | вкладка «Основное», блок «SMS-коды» |
| Включение входа через Яндекс ID и VK ID | подмодуль «Вход через соцсети» (вкладка «Модули») |
client_id приложений Яндекс ID и VK ID | вкладка «Ключи и токены» |
Ограничения авторизации
- Часть ошибок приходит телом
{errors: [...]}, часть —{success: false, error: текст}: читайте текст изerrorилиerrors[0]. - Единый ответ для гостя на методы только для вошедших —
401и{"success": false, "error": "Требуется авторизация"}; у методов этой группы он не встречается, они гостевые.
Что почитать после авторизации
- Сессия и авторизация: как передавать и хранить
X-Session-Id. - Профиль пользователя:
GET /api/userпосле входа. - Быстрый старт