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

Авторизация и регистрация

Группа /api/auth — вход, регистрация и восстановление пароля. Все методы вызывает гость. Методы, которые меняют состояние сессии (вход, выход, регистрация, подтверждение кода), начинают сессию: её ID приходит в заголовке ответа X-Session-Id, дальше витрина передаёт его заголовком запросов (см. Сессия и авторизация).

в этой теме 9
  1. Методы входа и регистрации
  2. Сценарий: вход по паролю
  3. Сценарий: вход и регистрация по SMS
  4. Сценарий: регистрация
  5. Сценарий: восстановление пароля
  6. Вход через соцсети
  7. Где настраиваются вход и регистрация
  8. Ограничения авторизации
  9. Что почитать после авторизации

Методы входа и регистрации

МетодАдресКто вызываетНачинает сессию
Вход по логину и паролюPOST /api/auth/loginгостьда
Вход по SMS: отправка кодаPOST /api/auth/loginByCodeгостьда
Подтверждение кода из SMSPOST /api/auth/confirmгостьда
Повторная отправка кодаPOST /api/auth/resendCodeгостьда
Регистрация по телефону или e-mailPOST /api/auth/registerгостьда
Вход через Яндекс IDPOST /api/auth/loginByYandexгостьда
Вход через VK IDPOST /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 (Профиль пользователя).

Сценарий: вход по паролю

  1. Витрина отправляет POST /api/auth/login с логином и паролем.
  2. Из заголовка ответа X-Session-Id берёт идентификатор сессии и сохраняет его.
  3. Следующие запросы (GET /api/user, корзина, заказы) идут с этим заголовком.
bash
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
json
{
    "success": true
}

Если Битрикс отказал во входе (неверный логин или пароль, пользователь заблокирован), статус 403, в error его текст:

json
{
    "success": false,
    "error": "Неверный логин или пароль."
}

Сценарий: вход и регистрация по SMS

  1. POST /api/auth/loginByCode с phoneNumber (любой формат с кодом страны) отправляет код на номер. Если пользователя с таким номером нет, он регистрируется (как в register).
  2. В ответе signedData — подписанная строка; витрина показывает поле для кода.
  3. POST /api/auth/confirm с code (ровно 6 цифр) и signedData проверяет код, подтверждает номер и авторизует пользователя. В data приходит профиль.
  4. Кнопка «Отправить код ещё раз» — POST /api/auth/resendCode с тем же phoneNumber.
json
{
    "data": {
        "signedData": "подписанная-строка",
        "dataSign": "подписанная-строка",
        "dateSend": "2026-01-01 12:00:00"
    }
}

Ответ confirm:

json
{
    "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 (сколько попыток осталось):

json
{
    "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.

json
{
    "data": {
        "message": "Вы успешно зарегистрированы.",
        "type": "OK",
        "id": 12
    }
}

Сценарий: восстановление пароля

  1. POST /api/auth/sendPassword с login и email отправляет письмо с контрольной строкой.
  2. Страница витрины, куда ведёт ссылка из письма, вызывает POST /api/auth/restorePassword с login, checkword (строка из письма) и новым password.
  3. Результат Битрикса — 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": "Требуется авторизация"}; у методов этой группы он не встречается, они гостевые.

Что почитать после авторизации

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

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

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