Инфоблок

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

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

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

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

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

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

Методы REST API

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

1) /api/iblock/gallery

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

{
    "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": false,
                "feature": []
            }
        }
    },
    "PHPSESSID": "nHAgYMqJ02f5tdOQ1AgBnluRRaUIplX5"
}

iblock.properties - возвращает все свойства инфоблока, отмеченные как Показывать на странице списка элементов.

2) /api/iblock/gallery/element

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

{
    "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   #Смещение
    },
    "PHPSESSID": "ZrLS5661KfYCEgpHf9f80GMenF158rhw"
}

properties - все свойства инфоблока, отмеченные как Показывать на странице списка элементов
lists - списки в которые добавлены элементы для текущего пользователя: избранное, сравнение и т.д.

3) /api/iblock/gallery/element/[elementIDorCode]

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

GET запрос

{
    "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
            }
        }
    },
    "PHPSESSID": "ZrLS5661KfYCEgpHf9f80GMenF158rhw"
}

4) /api/iblock/gallery/elementFilter

Endpoint возвращает список элементов по фильтру

GET запрос

5) /api/iblock/gallery/menuTree

Endpoint возвращает иерархию разделов c элементами инфоблока

GET запрос

6) /api/iblock/gallery/section

Endpoint возвращает все активные разделы инфоблока

GET запрос

{
    "data": [
        {
            "id": 17,               # ID раздела
            "sort": 500,            # Сортировка
            "name": "Раздел",       # Название
            "code": "",             # Символьный код
            "iblockSectionId": 0,   # ID родительского раздела
            "depthLevel": 1,        # Уровень вложенности
            "picture": null,        # Изображение
            "detailPicture": null,  # Детальная картинка
            "userFields": [],       # Пользовательские свойства раздела
            "count": "1"            # Кол-во элементов
        }
    ],
    "PHPSESSID": "Om37UpumnhAmw71fJ6dl5Yy2EhcEp5Uy"
}

7) /api/iblock/gallery/section/[sectionIDorCode]

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

GET запрос

8) /api/iblock/gallery/tree

Endpoint возвращает иерархию разделов инфоблока

GET запрос

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

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

Перейти в настройки инфоблока
Открыть вкладку Свойства
Обязательно указать код и название Свойства
Перейти в настройки свойства инфоблока
Поставить галочку на Показывать на странице списка элементов, если нужно, чтобы в properties вернулись свойства для /api/iblock/gallery/element
Поставить галочку на Показывать на детальной странице элемента, если нужно, чтобы в properties вернулись свойства для /api/iblock/gallery/element/[elementIDorCode]

Last modified: 19 июня 2025