Инфоблоки тема 13 из 27

Инфоблок

Инфоблок в Bitrix — это модуль для хранения и управления различными типами информации на сайте, такими как новости и товары. Модуль BIK.REST-API предоставляет функционал для манипуляций с элементами инфоблоков.

в этой теме 3
  1. Настройка инфоблока
  2. Методы REST API
  3. Свойства инфоблока

Настройка инфоблока

Перед началом работы с методами REST API необходимо правильно настроить инфоблок. Для примера будем использовать инфоблок Галерея.

Для настройки:

  1. Перейти в настройки инфоблока
  2. Указать символьный код API
  3. Поставить галочку на Включен доступ через REST
  4. Сохранить
Настройки инфоблока: символьный код API и доступ через REST

После настройки инфоблока станут доступны методы REST API, а также будет сгенерирована документация Swagger.

Методы REST API

Будем рассматривать на примере инфоблока Галерея. Символьный код API инфоблока - gallery.

Endpoint возвращает информацию про инфоблок с его свойствами.

json
{
    "iblock": {
        "id": 8,                    # ID
        "type": null,               # Тип инфоблока
        "code": "gallery",          # Символьный код
        "name": "Галерея",          # Название
        "picture": null,            # Изображение
        "description": "",          # Описание
        "descriptionType": "text",  # Тип описания (Текст, HTML)
        "properties": {             # Свойства
            "link": {
                "id": 33,
                "name": "Ссылка",
                "code": "LINK",
                "propertyType": "S",
                "userType": "",
                "multiple": "N",
                "feature": []
            }
        }
    }
}
  • iblock.properties - свойства инфоблока, которые входят в набор ответа «Список» (вкладка «Инфоблоки» настроек модуля), см. Состав ответа инфоблоков.

Endpoint возвращает массив всех активных элементов инфоблока с его свойствами.

json
{
    "data": [
        {
            "id": 317,                            # ID элемента
            "xmlId": "317",                       # Xml id элемента  
            "sort": 500,                          # Сортировка
            "name": "Элемент 1",                  # Название
            "previewText": "",                    # Описание для анонса
            "code": "",                           # Символьный код
            "activeFrom": null,                   # Начало активности
            "activeTo": null,                     # Окончание активности
            "iblockSectionId": 0,                 # ID раздела
            "iblockSection": null,                # Массив ID разделов
            "dateCreate": "23.09.2024 12:09:01",  # Создан
            "timestampX": "23.09.2024 12:14:22",  # Время последнего изменения полей элемента
            "previewPicture": null,               # Картинка для анонса
            "detailPicture": null,                # Детальная картинка
            "lists": [],                          # Списки
            "properties": {                       # Свойства
              "link": {                           # Код свойства
                "id": 33,                         # ID свойства
                "value": "google.com",            # Значение свойства
                "description": null               # Описание свойства
              }
            }
        }
    ],
    "pagen": {
        "total": 1,   #Общее кол-во записей
        "limit": 10,  #Лимит
        "offset": 0   #Смещение
    }
}
  • properties - свойства инфоблока из набора ответа «Список» (вкладка «Инфоблоки», см. Состав ответа инфоблоков)
  • lists - списки в которые добавлены элементы для текущего пользователя: избранное, сравнение и т.д.

Endpoint возвращает элемент инфоблока по ID или CODE

GET запрос

json
{
    "data": {
        "id": 317,
        "xmlId": "317",
        "sort": 500,
        "name": "Элемент 1",
        "previewText": "",
        "detailText": "",
        "code": "",
        "activeFrom": null,
        "activeTo": null,
        "iblockSectionId": 0,
        "iblockSection": null,
        "dateCreate": "23.09.2024 12:09:01",
        "timestampX": "23.09.2024 12:14:22",
        "previewPicture": null,
        "detailPicture": null,
        "seo": {
            "title": null,
            "keywords": null,
            "description": null
        },
        "lists": [],
        "properties": {
            "link": {
              "id": 33,
              "value": "google.com",
              "description": null
            }
        }
    }
}

Endpoint возвращает секции инфоблока: список или дерево по набору «Секции» (раздел «Инфоблоки» в настройках модуля).

Параметры: parent - ID или код родительской секции (по умолчанию корень); depth - 1 плоский список, N - дерево на N уровней (подсекции в children), 0 - все уровни (по умолчанию 1); order - {"sort":"asc"} (поля sort, name, id, code). Флаги, которые администратор разрешает на инфоблок (по умолчанию выключены): withCount=Y добавляет count - активные элементы секции с подсекциями (с filter как у /elements секции без подходящих элементов не выводятся); withElements=Y добавляет elements у секций (набор «Вложенный», предел элементов 200 по умолчанию, элементы без секции - meta.rootElements). Неразрешённый флаг - ошибка 400 с названием параметра.

GET запрос /api/iblock/gallery/sections?parent=medtehnika&depth=2&withCount=Y

json
{
    "data": [
        {
            "id": 321,
            "code": "tonometry",
            "name": "Тонометры",
            "count": 54,
            "children": [
                {"id": 330, "code": "avtomaticheskie", "name": "Автоматические", "count": 40, "children": []}
            ]
        }
    ]
}

Поля секции (id, code, name, sort, depthLevel, parentId, xmlId, picture, detailPicture, description, userFields) задаёт набор «Секции».

Endpoint возвращает одну секцию по ID или коду по набору «Секция»: поля, userFields, path (от корня до секции), seo. Без подсекций, количества и фильтра: подсекции - /sections?parent=, фильтр, цены и количество - /smartFilter?section=.

Endpoint возвращает умный фильтр каталога. Включается на инфоблок в разделе «Инфоблоки» (выключен - 404, в Swagger его нет).

Параметры: section - ID или код секции, можно несколько через запятую (область товаров); filter - выбранное {"properties":{"101":[555]},"price":{"from":100,"to":900}}; sectionsRoot - от какой секции строить sections (по умолчанию подсекции section). Ответ data: properties[] (свойства с флагом «Показывать в умном фильтре» у секций области, у значений count по режиму счётчиков инфоблока), prices (from, to; только у торгового каталога), sections[] (подсекции с count под выбор; секции с нулём выводятся).

Старые адреса /section, /section/{код}, /tree, /menuTree, /elementFilter удалены (404).

Свойства инфоблока

По умолчанию свойства не возвращаются.

  1. Перейти в настройки инфоблока
  2. Открыть вкладку Свойства
  3. Обязательно указать код и название Свойства
  4. Перейти в настройки свойства инфоблока
  5. Состав свойств в ответе задают наборы «Список» (/api/iblock/gallery/elements) и «Детальная» (/api/iblock/gallery/elements/[elementIDorCode]) на вкладке «Инфоблоки» настроек модуля: добавьте свойство в нужный набор. Подробнее - Состав ответа инфоблоков.
  6. Свои элементы пользователя - /api/iblock/gallery/elements?own=Y, см. Свои данные. Сессия передаётся заголовком X-Session-Id (Сессия), в тело ответа ID сессии не попадает.
Настройка свойства инфоблока: флаги вывода и приёма в POST-запросах

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

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

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