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

Быстрый старт

Эта тема проводит от установленного модуля до первого ответа вашего инфоблока в документации API. Нужно около десяти минут и доступ администратора сайта.

в этой теме 7
  1. 1. Установите модуль
  2. 2. Откройте инфоблок для API
  3. 3. Выберите, что отдаёт ответ
  4. 4. Сделайте первый запрос
  5. 5. Откройте документацию API
  6. Требования к серверу
  7. Что почитать после быстрого старта

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

Админ.панель -> Настройки -> Настройки продукта -> Модули -> BIK.REST -> «Установить». Установщик создаёт файлы /api/index.php, таблицы настроек и страницу руководства.

После установки откройте Настройки -> Настройки продукта -> Настройки модулей -> BIK.REST и нажмите «Обновить схему БД»: кнопка идемпотентна, её безопасно нажимать после каждого обновления модуля.

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

В настройках инфоблока (Контент -> Инфоблоки -> тип -> инфоблок -> «Изменить») задайте символьный код API и включите доступ через REST. Сохраните.

Настройки инфоблока: символьный код API и доступ через REST

Код API становится частью адреса: для кода catalog методы будут /api/iblock/catalog, /api/iblock/catalog/elements и другие. Список методов и их назначение — в теме Инфоблок.

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

Откройте вкладку «Инфоблоки» в настройках модуля, выберите инфоблок слева, на табе «Элементы» чипами отметьте поля и свойства для набора «Список». Пока набор не сохранён, ответ остаётся таким же, как до настройки. Подробно — в теме Состав ответа.

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

bash
curl "https://example.ru/api/iblock/catalog/elements?limit=1"

Ответ (сокращён):

json
{
    "data": [
        {
            "id": 4,
            "name": "Штаны Полосатый Рейс",
            "code": "pants-striped-flight",
            "active": "Y",
            "iblockSectionId": 8,
            "properties": {
                "artnumber": { "id": 9, "value": "177-77-хх", "description": null }
            }
        }
    ],
    "pagen": { "total": 10038, "limit": 1, "offset": 0 }
}

Ключи ответа — camelCase, логические значения — строки "Y" / "N". Гостю сессия не нужна и не выдаётся: читающие запросы работают без неё.

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

Документация Swagger — /api/doc/, описание в JSON — /api/doc/json. В ней у каждого метода есть параметры, пример запроса и пример ответа, а у инфоблока — «Состав ответа» и примеры, собранные из ваших настроек.

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

По умолчанию документация открыта всем; на рабочем сайте выберите «Только администраторам» (вкладка «Основное», раздел «Документация API и журнал», «Документация API (Swagger) открыта всем»). Нажмите «Try it out» у метода GET /api/iblock/{код}/elements и убедитесь, что в ответе ваш инфоблок — это и есть результат быстрого старта.

Требования к серверу

ЧтоТребование
Платформа1С-Битрикс «Управление сайтом»
PHP8.0 и выше
Модули Битриксаобязательные: main, iblock, catalog, sale, highloadblock; по возможностям: search (поиск), form (веб-формы), subscribe (рассылки), messageservice (SMS)
Сторонние модули (по желанию)ipol.sdek — СДЭК; awz.iptown — город по IP
Composer и сторонние библиотекине нужны
Сайтфайл 404.php; запросы /api/* должны доходить до /api/index.php (правило адресов добавляет установщик; для nginx — try_files … /bitrix/urlrewrite.php, на BitrixVM и «Битрикс: Веб-окружение» уже есть)
Сессиякаталог bitrix/cache/ доступен веб-серверу на запись; витрина передаёт X-Session-Id; если CORS отдаёт nginx — добавить X-Session-Id в Allow-Headers и Expose-Headers
Кешна сайте включён управляемый кеш Битрикса
Умный фильтрфасетный индекс инфоблока каталога (модуль перестраивает его сам после выгрузки из 1С и по крону)
Поиск местоположенийпостроенный поисковый индекс местоположений магазина
Рекомендуетсяapplication/json в gzip_types nginx

Что почитать после быстрого старта

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

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

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