BIK.REST-API модуль REST API для 1С-Битрикс
Модуль для сайтов на «1С-Битрикс: Управление сайтом», не для Битрикс24. Каталог, умный фильтр, корзина, оформление заказа, личный кабинет и формы — через готовый REST API. Документация API строится сама, а состав ответа настраивается в админке чипами, без программирования.

знакомо?
Витрина собрана из шаблонов компонентов: фронтенд и бэкенд в одном коде, фронтенд-разработчик ждёт бэкендера.
Витрина — отдельное приложение: сайт, SPA или мобильное. Каталог, фильтр, корзина и заказ уже доступны через готовый API — фронтенд работает, не дожидаясь бэкендера.
Бэкенд API пишется заново под каждый проект, и ответы разных проектов устроены по-разному.
Одно общее ядро для всех проектов: одинаковые методы и одинаково устроенные ответы. Бэкенд не пишется, а настраивается.
Документация API расходится с реальностью — или её нет совсем.
Документация строится из того же кода, что и сами методы, и всегда соответствует установленной версии. Примеры запросов и ответов собираются из данных сайта.
Чтобы добавить поле в ответ, нужна задача программисту, правка кода и выкладка.
Состав ответа выбирается в админке чипами: добавьте поле и сохраните. Кеш сбросится сам, изменения видны сразу.
Проектные правки делают прямо в ядре, а потом они мешают обновлениям.
Доработки живут отдельно от модуля: события «до / после» и свои классы на сайте. Обновление модуля их не затрагивает.
возможности
Быстрее запуск новой витрины: бэкенд не пишется, а настраивается. Битрикс, 1С, менеджеры и процессы — без изменений.
Любой раздел сайта — каталог, новости, акции — открывается для витрины настройкой в админке, без задачи программисту. Витрина получает ровно нужные данные, а умный фильтр работает как на привычном Битрикс-сайте и не ломается после обмена с 1С.
Корзина, оформление заказа, доставка, оплата, купоны и бонусы готовы. Правила магазина, скидки, доставки и оплаты остаются в Битриксе — менеджеры работают как раньше, витрина просто их использует.
Вход по паролю, по коду из SMS, через Яндекс ID и VK ID, профиль, избранное, сравнение и подписки на поступление товара. Личный кабинет помогает удерживать покупателя.
Отзывы, заявки и обращения попадают в Битрикс без отдельной разработки. Кто может отправлять, капча для гостей, лимит отправок и модерация — галочками в админке.
Меньше рисков утечки сессий и данных: номер сессии не попадает в адрес страницы и журналы сервера, внутренние ошибки не показываются посетителю, ключи сервисов хранятся только в админке.
Быстрые страницы каталога и стабильная работа под нагрузкой: 5 слоёв кеша со своими сроками сбрасываются сами при изменении данных и обмене с 1С — вручную ничего чистить не нужно.
Фронтенд-подрядчик стартует без созвонов и переписки «а что возвращает этот метод»: описание каждого метода строится само и не устаревает.
Руководство встроено в админку Битрикса, у настроек — ссылки «Подробнее». Меньше зависимости от конкретного разработчика.
Проект можно дорабатывать под себя и при этом получать обновления модуля: доработки живут отдельно и при обновлении не ломаются.
Типовые сервисы интернет-магазина подключаются ключом в админке: Яндекс.Карты, DaData, reCAPTCHA, Яндекс ID, VK ID, SMS, Битрикс24, Loymax, СДЭК и обмен с 1С.
возможности
Что умеет модуль технически — с адресами методов и ссылками на темы документации.
Инфоблок открывается «Символьным кодом API» и флагом «Доступ через REST» — адреса предсказуемы: /api/iblock/{код}/elements, /sections, /sections/{код}. Свои наборы полей для списка, карточки, вложенного элемента и корзины, свои поля — классами в /local/bik.rest/fields/. Умный фильтр — одним запросом GET /api/iblock/{код}/smartFilter: значения, счётчики, диапазон цен.
Полный путь покупателя покрыт методами: корзина (и для гостя), купоны, расчёт цен и скидок без корзины, пересчёт и сохранение заказа, доставка, местоположения и данные виджета СДЭК, оплата штатными платёжными системами Битрикса, история и отмена заказа, бонусный счёт. На бэкенде ничего не дописывается.
Вход по логину и паролю, коду из SMS, через Яндекс ID и VK ID, регистрация и восстановление пароля. Какие поля профиля читать, менять и принимать при регистрации — выбирается чипами, служебные поля не отдаются никогда. Избранное, сравнение и просмотренные работают одинаково для гостя и пользователя.
POST, PUT и DELETE /api/iblock/{код}/elements с правилами на табе «Запись»: кто создаёт, меняет и видит, модерация, reCAPTCHA для гостей, лимит отправок с IP, принимаемые поля. По умолчанию запись выключена: выключенный метод отвечает 404 и не виден в документации, каждый отказ — с понятным текстом.
Сессия — заголовком X-Session-Id, не адресом и не телом ответа; гость, который только читает каталог, сессию не получает. Единый 401 «Требуется авторизация» у всех методов для вошедших, CORS — белый список витрин с масками (https://*.site.ru, http://localhost:*), внутренние ошибки клиенту не раскрываются.
Слои кеша — элементы, секции, умный фильтр, цены и остатки, справочники — со сроками в админке и переопределением для инфоблока; сброс по изменению данных, в том числе при обмене с 1С. Страница списка собирается пакетно, данные пользователя не кешируются.
Swagger / OpenAPI 3 строится из того же кода и настроек, что и методы: параметры с умолчаниями, примеры из данных сайта, ошибки, события метода и кнопка «Try it out». Описание проходит валидатор OpenAPI — его можно отдать генератору клиента.
Темы руководства ставятся вместе с модулем: раздел админки «Руководство» с оглавлением и поиском и тот же текст на /api/doc/guide. У настроек — ссылки «Подробнее», у групп методов в Swagger — «как этим пользоваться».
События «до / после» у каждого метода — изменить параметры, остановить запрос, подменить ответ — и события сборки ответа, обработчики в init.php. Свои методы, поля, подмодули и страницы настроек — в /local/bik.rest/, свои методы сами попадают в Swagger.
Прокси к сервисам на бэкенде — ключи не светятся на фронте: Яндекс Геокодер, DaData, reCAPTCHA v2, Яндекс ID, VK ID, SMS через messageservice, лиды в Битрикс24, Loymax, СДЭК через ipol.sdek, обмен с 1С с автовосстановлением фасетного индекса.
как это работает
Битрикс остаётся вашей админкой и бэкендом, а витрина — любым современным фронтендом. BIK.REST-API соединяет их готовым, документированным API.
настройки в админке
где работает модуль
сравнение
| Задача | Как обычно на Битриксе | С BIK.REST-API |
|---|---|---|
| Отдельный фронтенд | Писать свой слой API под каждый проект | Готовые методы каталога, корзины, заказа и личного кабинета — более 100 |
| Добавить поле в ответ | Задача программисту: правка кода и выкладка | Чип в админке → «Сохранить настройки инфоблока», кеш сбрасывается сам |
| Документация для фронтенда | Пишется вручную и устаревает | Swagger / OpenAPI строится из кода и данных сайта, с примерами |
| Фильтр каталога | Компонент catalog.smart.filter в шаблоне | GET /smartFilter — значения, счётчики и цены одним запросом |
| Формы и отзывы | Компонент формы и своя защита | Таб «Запись»: права, капча, лимит по IP, модерация |
| Сессия для SPA и приложения | PHPSESSID в адресе или cookie, проброс в init.php | Заголовок X-Session-Id, без данных в адресе |
| Ошибка «не авторизован» | Разная в разных методах | Единый ответ 401 у всех методов для вошедших |
| Кеш | Сроки зашиты в компонентах | 5 слоёв со сроками в админке, сброс при изменении данных |
| Доработка под проект | Правка модуля или ядра, конфликт при обновлении | События «до / после» и свои классы в /local/bik.rest/ |
| Фильтр после выгрузки из 1С | Ручная перестройка фасетного индекса | Перестраивается сам после выгрузки и по расписанию |
| Ключи сервисов | Часто лежат в коде | Вкладка «Ключи и токены», секреты скрыты |
цифры
Ответы легче: витрина получает только поля из набора. На демо-стенде агентства в версии 3.0 ответ со списком из 20 товаров стал легче на 45%.
быстрый старт
Около 10 минут и доступ администратора сайта. Для витрины на другом домене добавьте её адрес на вкладке «Основное → Витрина и доступ из браузера».
Настройки → Настройки продукта → Модули → BIK.REST-API (в списке модулей Битрикса — BIK.REST) → «Установить». Затем в настройках модуля нажмите «Обновить схему БД» — её безопасно нажимать после каждого обновления.
В настройках инфоблока задайте «Символьный код API», например catalog, и включите «Доступ через REST».
Вкладка «Инфоблоки» → инфоблок → таб «Элементы»: чипами отметьте поля и свойства набора «Список».
curl "https://example.ru/api/iblock/catalog/elements?limit=1" — в ответе товары вашего каталога.
Адрес /api/doc/ на вашем сайте: нажмите «Try it out» у любого метода — в ответе ваш инфоблок.
примеры запросов
Сняты с демо-стенда агентства и сокращены. Адрес сайта в примерах — example.ru, подставьте свой.
Ключи — camelCase, логические значения — "Y" / "N". Набор полей задан в админке чипами, гостю сессия не нужна.
curl "https://example.ru/api/iblock/catalog/elements?limit=1" {
"data": [
{
"id": 4,
"name": "Штаны Полосатый Рейс",
"code": "pants-striped-flight",
"active": "Y",
"iblockSectionId": 8,
"section": { "id": 8, "name": "Штаны", "code": "pants" },
"properties": {
"artnumber": { "id": 9, "value": "177-77-хх", "description": null },
"material": { "id": 11, "value": ["трикотаж"], "description": null }
},
"offers": [
{
"id": 42,
"code": "pants-striped-flight-f-l",
"product": {
"quantity": 100,
"price": { "price": 1999, "currency": "RUB", "basePrice": 1999, "discount": 0 }
}
}
]
}
],
"pagen": { "total": 10038, "limit": 1, "offset": 0 }
} Разделы первого уровня и число товаров в каждом — одним запросом, для меню каталога.
curl "https://example.ru/api/iblock/catalog/sections?depth=1&withCount=Y" {
"data": [
{ "id": 1, "name": "Обувь", "code": "shoes", "parentId": null, "depthLevel": 1, "count": 7 },
{ "id": 7, "name": "Платья", "code": "dresses", "parentId": null, "depthLevel": 1, "count": 4 },
{ "id": 8, "name": "Штаны", "code": "pants", "parentId": null, "depthLevel": 1, "count": 3 }
]
} Значения свойств со счётчиками, диапазон цен и разделы — всё, что нужно фильтру каталога, одним запросом.
curl "https://example.ru/api/iblock/catalog/smartFilter" {
"data": {
"properties": [
{
"id": 5, "code": "BRAND_REF", "name": "Бренд",
"values": [
{ "id": 18, "value": "Фэшн хаус", "count": 5 },
{ "id": 2, "value": "Одежда+", "count": 19 }
]
}
],
"prices": { "from": 101, "to": 10000 },
"sections": [ "…" ]
}
} После входа сессия приходит в заголовке X-Session-Id, и витрина передаёт её тем же заголовком — без данных в адресе. Без сессии метод для вошедших отвечает 401.
curl -i -X POST "https://example.ru/api/auth/login" \
-H "Content-Type: application/json" \
-d '{"username": "user@example.ru", "password": "secret"}'
# в заголовках ответа:
# X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ
curl "https://example.ru/api/user" -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ" { "success": false, "error": "Требуется авторизация" } Интерактивная документация API демо-стенда: каждый метод можно вызвать кнопкой «Try it out».
как купить
98 700 ₽
1 сайт · обновления 1 год
вместе с модулем
требования
Обязательные модули Битрикса
вопросы
Модуль сделан для витрин отдельно от Битрикса: SPA, сайта, мобильного приложения. Обычным шаблонам он не мешает — флаги свойств, которые меняют чипы, читают и компоненты сайта. Можно начать с API для приложения, а сайт оставить на шаблонах.
Нужны 1С-Битрикс: Управление сайтом, PHP 8.0 и выше и модули Битрикса «Главный модуль», «Информационные блоки», «Торговый каталог», «Интернет-магазин» и «Highload-блоки». Полные требования к серверу — в теме «Быстрый старт» документации.
Модуль работает через штатные API Битрикса и не требует правки ядра.
Да. У каждого метода есть события «до» и «после», а свои методы, поля, подмодули и страницы настроек кладутся в /local/bik.rest/ — обновление модуля их не затрагивает.
Версии идут по правилу: major — ломающие изменения, minor — новые методы, patch — исправления. К каждой версии есть описание изменений и чек-лист выкладки. В major-версиях обратная совместимость API не сохраняется — так было в 3.0.0 и 4.0.0.
Сессия передаётся только заголовком, не в адресе; ответ на ошибку входа — единый 401; CORS — по белому списку с проверкой масок; внутренние ошибки наружу не раскрываются. Запись в инфоблоки выключена по умолчанию, а включённая — с капчей, лимитом по IP и модерацией. Ключи сервисов хранятся только в админке, документацию можно закрыть от всех, кроме администраторов.
5 слоёв кеша со сроками в админке и автосбросом при изменении данных, пакетная сборка ответа, а витрина получает только поля из набора.
Да: данные приходят штатным обменом Битрикса, а после выгрузки модуль сам перестраивает фасетный индекс умного фильтра.
Логин и пароль, телефон и SMS-код, Яндекс ID и VK ID. Регистрация — по телефону или e-mail.
Да: Swagger / OpenAPI 3 на адресе /api/doc/ вашего сайта с примерами из его данных и руководство из 27 тем — в админке Битрикса и в разделе «Документация» на этом сайте.
Подключение инфоблока, состав ответа, правила записи, кеш и ключи сервисов настраиваются в админке. Установка и настройка сервера (nginx, CORS) — задача администратора или разработчика.
98 700 ₽ за лицензию на 1 сайт, в цену входит год обновлений. Купить модуль можно у агентства, а после публикации карточки — и на Маркетплейсе 1С-Битрикс по той же цене. Агентство устанавливает и настраивает модуль и ведёт его техподдержку. Посмотреть модуль в работе можно на демо-стенде.
REST API Битрикс24 — это API облачной и коробочной CRM. BIK.REST-API — модуль для сайтов и интернет-магазинов на «1С-Битрикс: Управление сайтом»: он даёт витрине каталог, корзину, заказы и личный кабинет.
Оставьте заявку — установим и настроим модуль, ответим на вопросы по API.