Начало работы тема 1 из 27

Введение в модуль BIK.REST-API

BIK.REST-API — модуль для 1С-Битрикс «Управление сайтом», который отдаёт данные сайта через REST API: каталог с умным фильтром, корзину, оформление заказа, личный кабинет и формы. Витрина — SPA, отдельный сайт или мобильное приложение — обращается к Битриксу по HTTP и получает JSON, а какие поля попадают в ответ, администратор выбирает в админке. Руководство описывает версию 4.0.0.

в этой теме 2
  1. Что умеет модуль
  2. Как читать руководство

Что умеет модуль

  1. Инфоблоки. Инфоблок, которому включили доступ через REST, получает группу методов /api/iblock/<код>: описание, список и карточка элементов, список секций и секция. Умный фильтр и запись (отзывы, заявки) включаются отдельно, запись по умолчанию выключена. Поля и свойства ответа выбираются чипами на вкладке «Инфоблоки» настроек модуля.
  2. Магазин. Готовые методы для корзины, оформления и истории заказов, доставки и местоположений, оплаты, профилей покупателя, избранного и сравнения.
  3. Пользователи. Вход по паролю и по коду из SMS, через Яндекс ID и VK ID, регистрация, восстановление пароля и профиль. Сессия передаётся только заголовком X-Session-Id.
  4. Документация Swagger. Описание API в формате OpenAPI 3.0 строится автоматически по настройкам сайта: включили инфоблок или подмодуль — методы появились в документации.
  5. Кеш. Ответы кешируются слоями со своими сроками и сбрасываются сами при изменении элементов, цен, остатков и настроек.
  6. Расширение без правки модуля. События «до / после» у каждого метода, свои методы 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/. Начать знакомство удобнее с быстрого старта.

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

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

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