Что умеет модуль
- Инфоблоки. Инфоблок, которому включили доступ через REST, получает группу методов
/api/iblock/<код>: описание, список и карточка элементов, список секций и секция. Умный фильтр и запись (отзывы, заявки) включаются отдельно, запись по умолчанию выключена. Поля и свойства ответа выбираются чипами на вкладке «Инфоблоки» настроек модуля. - Магазин. Готовые методы для корзины, оформления и истории заказов, доставки и местоположений, оплаты, профилей покупателя, избранного и сравнения.
- Пользователи. Вход по паролю и по коду из SMS, через Яндекс ID и VK ID, регистрация, восстановление пароля и профиль. Сессия передаётся только заголовком
X-Session-Id. - Документация Swagger. Описание API в формате OpenAPI 3.0 строится автоматически по настройкам сайта: включили инфоблок или подмодуль — методы появились в документации.
- Кеш. Ответы кешируются слоями со своими сроками и сбрасываются сами при изменении элементов, цен, остатков и настроек.
- Расширение без правки модуля. События «до / после» у каждого метода, свои методы API, поля элементов, подмодули и страницы настроек — в каталоге
/local/bik.rest/сайта; обновление модуля их не затрагивает.
Как читать руководство
27 тем разбиты на 6 групп:
| Группа | Темы |
|---|---|
| Начало работы | Быстрый старт от установки до первого запроса, настройки модуля и требования к серверу |
| Сессия и пользователи | сессия и единый ответ 401, вход и регистрация, профиль, профили покупателя, списки |
| Магазин | корзина, заказ, доставка, оплата |
| Инфоблоки | подключение инфоблока, поля и форматеры, состав ответа, секции, умный фильтр, запись, личные данные, картинки |
| Сервисы и производительность | служебные методы, кеш, Swagger |
| Расширение модуля | события, свой метод API, свой подмодуль, своя страница настроек |
Примеры запросов написаны для адреса example.ru — подставьте адрес своего сайта; ответы в примерах сокращены. Ключи ответа — в camelCase, логические значения — строки "Y" / "N".
То же руководство встроено в админку Битрикса — раздел «Сервисы → BIK.REST → Руководство», с поиском по темам — и открывается на сайте с модулем по адресу /api/doc/guide.
Каждый метод можно вызвать прямо из документации API на демо-стенде: https://api-bikrest.bikdev.ru/api/doc/. Начать знакомство удобнее с быстрого старта.