BIK.REST-API модуль REST API для 1С-Битрикс

REST API для 1С-Битрикс: готовый бэкенд для витрины, приложения и SPA

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

версия 4.0.0 · 98 700 ₽

Настройки модуля BIK.REST в админке Битрикса: состав ответа API для инфоблока выбирается чипами — поля, свойства, каталог, служебное

знакомо?

Что мешает делать витрину на Битриксе

  1. как обычно на Битриксе

    Витрина собрана из шаблонов компонентов: фронтенд и бэкенд в одном коде, фронтенд-разработчик ждёт бэкендера.

    как с BIK.REST-API

    Витрина — отдельное приложение: сайт, SPA или мобильное. Каталог, фильтр, корзина и заказ уже доступны через готовый API — фронтенд работает, не дожидаясь бэкендера.

  2. как обычно на Битриксе

    Бэкенд API пишется заново под каждый проект, и ответы разных проектов устроены по-разному.

    как с BIK.REST-API

    Одно общее ядро для всех проектов: одинаковые методы и одинаково устроенные ответы. Бэкенд не пишется, а настраивается.

  3. как обычно на Битриксе

    Документация API расходится с реальностью — или её нет совсем.

    как с BIK.REST-API

    Документация строится из того же кода, что и сами методы, и всегда соответствует установленной версии. Примеры запросов и ответов собираются из данных сайта.

  4. как обычно на Битриксе

    Чтобы добавить поле в ответ, нужна задача программисту, правка кода и выкладка.

    как с BIK.REST-API

    Состав ответа выбирается в админке чипами: добавьте поле и сохраните. Кеш сбросится сам, изменения видны сразу.

  5. как обычно на Битриксе

    Проектные правки делают прямо в ядре, а потом они мешают обновлениям.

    как с BIK.REST-API

    Доработки живут отдельно от модуля: события «до / после» и свои классы на сайте. Обновление модуля их не затрагивает.

возможности

Для бизнеса

Быстрее запуск новой витрины: бэкенд не пишется, а настраивается. Битрикс, 1С, менеджеры и процессы — без изменений.

  1. Каталог и инфоблоки

    Любой раздел сайта — каталог, новости, акции — открывается для витрины настройкой в админке, без задачи программисту. Витрина получает ровно нужные данные, а умный фильтр работает как на привычном Битрикс-сайте и не ломается после обмена с 1С.

  2. Магазин

    Корзина, оформление заказа, доставка, оплата, купоны и бонусы готовы. Правила магазина, скидки, доставки и оплаты остаются в Битриксе — менеджеры работают как раньше, витрина просто их использует.

  3. Пользователи и личный кабинет

    Вход по паролю, по коду из SMS, через Яндекс ID и VK ID, профиль, избранное, сравнение и подписки на поступление товара. Личный кабинет помогает удерживать покупателя.

  4. Отзывы и заявки с сайта

    Отзывы, заявки и обращения попадают в Битрикс без отдельной разработки. Кто может отправлять, капча для гостей, лимит отправок и модерация — галочками в админке.

  5. Сессия и безопасность

    Меньше рисков утечки сессий и данных: номер сессии не попадает в адрес страницы и журналы сервера, внутренние ошибки не показываются посетителю, ключи сервисов хранятся только в админке.

  6. Производительность

    Быстрые страницы каталога и стабильная работа под нагрузкой: 5 слоёв кеша со своими сроками сбрасываются сами при изменении данных и обмене с 1С — вручную ничего чистить не нужно.

  7. Документация API

    Фронтенд-подрядчик стартует без созвонов и переписки «а что возвращает этот метод»: описание каждого метода строится само и не устаревает.

  8. Руководство внутри модуля

    Руководство встроено в админку Битрикса, у настроек — ссылки «Подробнее». Меньше зависимости от конкретного разработчика.

  9. Доработки без правки модуля

    Проект можно дорабатывать под себя и при этом получать обновления модуля: доработки живут отдельно и при обновлении не ломаются.

  10. Интеграции

    Типовые сервисы интернет-магазина подключаются ключом в админке: Яндекс.Карты, DaData, reCAPTCHA, Яндекс ID, VK ID, SMS, Битрикс24, Loymax, СДЭК и обмен с 1С.

возможности

Для разработчиков

Что умеет модуль технически — с адресами методов и ссылками на темы документации.

  1. Каталог и инфоблоки

    Инфоблок открывается «Символьным кодом API» и флагом «Доступ через REST» — адреса предсказуемы: /api/iblock/{код}/elements, /sections, /sections/{код}. Свои наборы полей для списка, карточки, вложенного элемента и корзины, свои поля — классами в /local/bik.rest/fields/. Умный фильтр — одним запросом GET /api/iblock/{код}/smartFilter: значения, счётчики, диапазон цен.

  2. Магазин

    Полный путь покупателя покрыт методами: корзина (и для гостя), купоны, расчёт цен и скидок без корзины, пересчёт и сохранение заказа, доставка, местоположения и данные виджета СДЭК, оплата штатными платёжными системами Битрикса, история и отмена заказа, бонусный счёт. На бэкенде ничего не дописывается.

  3. Пользователи и личный кабинет

    Вход по логину и паролю, коду из SMS, через Яндекс ID и VK ID, регистрация и восстановление пароля. Какие поля профиля читать, менять и принимать при регистрации — выбирается чипами, служебные поля не отдаются никогда. Избранное, сравнение и просмотренные работают одинаково для гостя и пользователя.

  4. Отзывы и заявки с сайта

    POST, PUT и DELETE /api/iblock/{код}/elements с правилами на табе «Запись»: кто создаёт, меняет и видит, модерация, reCAPTCHA для гостей, лимит отправок с IP, принимаемые поля. По умолчанию запись выключена: выключенный метод отвечает 404 и не виден в документации, каждый отказ — с понятным текстом.

  5. Сессия и безопасность

    Сессия — заголовком X-Session-Id, не адресом и не телом ответа; гость, который только читает каталог, сессию не получает. Единый 401 «Требуется авторизация» у всех методов для вошедших, CORS — белый список витрин с масками (https://*.site.ru, http://localhost:*), внутренние ошибки клиенту не раскрываются.

  6. Производительность

    Слои кеша — элементы, секции, умный фильтр, цены и остатки, справочники — со сроками в админке и переопределением для инфоблока; сброс по изменению данных, в том числе при обмене с 1С. Страница списка собирается пакетно, данные пользователя не кешируются.

  7. Документация API

    Swagger / OpenAPI 3 строится из того же кода и настроек, что и методы: параметры с умолчаниями, примеры из данных сайта, ошибки, события метода и кнопка «Try it out». Описание проходит валидатор OpenAPI — его можно отдать генератору клиента.

  8. Руководство внутри модуля

    Темы руководства ставятся вместе с модулем: раздел админки «Руководство» с оглавлением и поиском и тот же текст на /api/doc/guide. У настроек — ссылки «Подробнее», у групп методов в Swagger — «как этим пользоваться».

  9. Доработки без правки модуля

    События «до / после» у каждого метода — изменить параметры, остановить запрос, подменить ответ — и события сборки ответа, обработчики в init.php. Свои методы, поля, подмодули и страницы настроек — в /local/bik.rest/, свои методы сами попадают в Swagger.

  10. Интеграции

    Прокси к сервисам на бэкенде — ключи не светятся на фронте: Яндекс Геокодер, DaData, reCAPTCHA v2, Яндекс ID, VK ID, SMS через messageservice, лиды в Битрикс24, Loymax, СДЭК через ipol.sdek, обмен с 1С с автовосстановлением фасетного индекса.

как это работает

Путь запроса: от витрины до 1С

Битрикс остаётся вашей админкой и бэкендом, а витрина — любым современным фронтендом. BIK.REST-API соединяет их готовым, документированным API.

  1. Витрина сайт, SPA, мобильное приложение
  2. API на сайте Битрикса запросы витрины приходят на ваш сайт
  3. Модуль BIK.REST-API методы, правила доступа, кеш
  4. Данные Битрикса инфоблоки, каталог, магазин, пользователи
    обмен
    1С товары, цены, остатки, заказы
  • в модуль Админка Битрикса настройки модуля
  • из модуля Внешние сервисы DaData, Яндекс, reCAPTCHA, SMS, Битрикс24, Loymax, СДЭК
  • из модуля Документация API описание методов и руководство

сравнение

Как обычно на Битриксе и с BIK.REST‑API

Как обычно на Битриксе и с BIK.REST‑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С Ручная перестройка фасетного индекса Перестраивается сам после выгрузки и по расписанию
Ключи сервисов Часто лежат в коде Вкладка «Ключи и токены», секреты скрыты

цифры

Модуль в цифрах

  • более 100 методов API 115 на демо-стенде: 81 общий, остальные зависят от инфоблоков сайта
  • около 10 минут от установки до первого ответа
  • 8 вкладок настроек в админке
  • 0 сторонних библиотек: только модули Битрикса
  • 4.0.0 текущая версия
  • 5 подмодулей
  • 5 слоёв кеша
  • 27 тем руководства

Ответы легче: витрина получает только поля из набора. На демо-стенде агентства в версии 3.0 ответ со списком из 20 товаров стал легче на 45%.

быстрый старт

От установки до первого ответа

Около 10 минут и доступ администратора сайта. Для витрины на другом домене добавьте её адрес на вкладке «Основное → Витрина и доступ из браузера».

  1. Установите модуль

    Настройки → Настройки продукта → Модули → BIK.REST-API (в списке модулей Битрикса — BIK.REST) → «Установить». Затем в настройках модуля нажмите «Обновить схему БД» — её безопасно нажимать после каждого обновления.

  2. Откройте инфоблок для API

    В настройках инфоблока задайте «Символьный код API», например catalog, и включите «Доступ через REST».

  3. Выберите, что отдаёт ответ

    Вкладка «Инфоблоки» → инфоблок → таб «Элементы»: чипами отметьте поля и свойства набора «Список».

  4. Сделайте первый запрос

    curl "https://example.ru/api/iblock/catalog/elements?limit=1" — в ответе товары вашего каталога.

  5. Откройте документацию

    Адрес /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"
GET /api/user без сессии — HTTP 401
{ "success": false, "error": "Требуется авторизация" }
Попробовать на демо-стенде

Интерактивная документация API демо-стенда: каждый метод можно вызвать кнопкой «Try it out».

как купить

Цена и способы покупки

98 700 ₽

1 сайт · обновления 1 год

  • У агентства напрямую

    вместе с модулем

    • Установка и настройка
    • Техподдержка модуля

требования

Что нужно для установки

платформа
1С-Битрикс: Управление сайтом
PHP
PHP 8.0 и выше
библиотеки
Composer и сторонние библиотеки не нужны

Обязательные модули Битрикса

  • Главный модуль
  • Информационные блоки
  • Торговый каталог
  • Интернет-магазин
  • Highload-блоки
Все требования

вопросы

частые вопросы

Нужен ли отдельный фронтенд?

Модуль сделан для витрин отдельно от Битрикса: SPA, сайта, мобильного приложения. Обычным шаблонам он не мешает — флаги свойств, которые меняют чипы, читают и компоненты сайта. Можно начать с API для приложения, а сайт оставить на шаблонах.

С какими версиями Битрикса совместим?

Нужны 1С-Битрикс: Управление сайтом, PHP 8.0 и выше и модули Битрикса «Главный модуль», «Информационные блоки», «Торговый каталог», «Интернет-магазин» и «Highload-блоки». Полные требования к серверу — в теме «Быстрый старт» документации.

Что будет при обновлении Битрикса?

Модуль работает через штатные API Битрикса и не требует правки ядра.

Можно ли дорабатывать под свой проект?

Да. У каждого метода есть события «до» и «после», а свои методы, поля, подмодули и страницы настроек кладутся в /local/bik.rest/ — обновление модуля их не затрагивает.

Как обновляется сам модуль? Ломается ли API?

Версии идут по правилу: major — ломающие изменения, minor — новые методы, patch — исправления. К каждой версии есть описание изменений и чек-лист выкладки. В major-версиях обратная совместимость API не сохраняется — так было в 3.0.0 и 4.0.0.

Насколько это безопасно?

Сессия передаётся только заголовком, не в адресе; ответ на ошибку входа — единый 401; CORS — по белому списку с проверкой масок; внутренние ошибки наружу не раскрываются. Запись в инфоблоки выключена по умолчанию, а включённая — с капчей, лимитом по IP и модерацией. Ключи сервисов хранятся только в админке, документацию можно закрыть от всех, кроме администраторов.

Как с производительностью?

5 слоёв кеша со сроками в админке и автосбросом при изменении данных, пакетная сборка ответа, а витрина получает только поля из набора.

Работает ли с 1С?

Да: данные приходят штатным обменом Битрикса, а после выгрузки модуль сам перестраивает фасетный индекс умного фильтра.

Какие способы входа?

Логин и пароль, телефон и SMS-код, Яндекс ID и VK ID. Регистрация — по телефону или e-mail.

Есть ли документация?

Да: Swagger / OpenAPI 3 на адресе /api/doc/ вашего сайта с примерами из его данных и руководство из 27 тем — в админке Битрикса и в разделе «Документация» на этом сайте.

Нужен ли программист для настройки?

Подключение инфоблока, состав ответа, правила записи, кеш и ключи сервисов настраиваются в админке. Установка и настройка сервера (nginx, CORS) — задача администратора или разработчика.

Лицензия, цена, поддержка, демо?

98 700 ₽ за лицензию на 1 сайт, в цену входит год обновлений. Купить модуль можно у агентства, а после публикации карточки — и на Маркетплейсе 1С-Битрикс по той же цене. Агентство устанавливает и настраивает модуль и ведёт его техподдержку. Посмотреть модуль в работе можно на демо-стенде.

Чем модуль отличается от REST API Битрикс24?

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

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

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

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