Документация для разработчиков
Темная тема

Концепция

REST API для инфоблоков доступен с версии 20.5.0 модуля Информационные блоки.


Для доступа к данным инфоблоков через REST за основу взята Интеграция с ORM С версии 19.0.0 модуля iblock добавлена поддержка ORM при работе с элементами инфоблоков.

Подробнее в курсе Разработчик Bitrix Framework.
. А именно концепция, когда один инфоблок – это одна самостоятельная сущность ORM, а элемент инфоблока – это запись (объект) сущности.

Запрос REST всегда производится в контексте одного инфоблока с указанием iblockId.

Примечание: Поддерживаются обе версии инфоблоков – 1.0 и 2.0.

По умолчанию REST выключен для всех инфоблоков. Для его включения необходимо в форме редактирования конкретного инфоблока в административном интерфейсе (Контент > Инфоблоки > Типы инфоблоков > [название_типа] > [название_инфоблока] ) установить галочку для опции Включен доступ через REST:

Убедитесь, что заполнено поле Символьный код API (API_CODE) – его наличие необходимо для работы механизма ORM.

Логика работы с записями реализована на механизме AJAX-контроллеров. По умолчанию для всех инфоблоков срабатывает контроллер \Bitrix\Iblock\Controller\DefaultElement.

Подстановка своей реализации методов возможна через Сервис локатор Сервис локатор (локатор служб) – это шаблон проектирования для удобной работы с сервисами приложения.

Подробнее в курсе Разработчик Bitrix Framework.
.


В настоящий момент работает Read-only режим доступа к элементам инфоблока. Доступны следующие методы получения и фильтрации записей:

МетодОписание
iblock.element.getПолучение элемента инфоблока по его идентификатору ID.
iblock.element.list Получение элементов инфоблока по заданному фильтру.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024