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

Состав ответа

Какие поля, свойства и вложенные данные отдаёт API, вы выбираете в админке, а не в коде. Настройка хранится по инфоблоку и по месту вывода элемента.

в этой теме 8
  1. Описание инфоблока и его свойств
  2. Наборы: где и что выводится
  3. Как настроить состав ответа
  4. Пример: список элементов
  5. Да / нет и параметры
  6. Свои элементы: own=Y
  7. Секции и умный фильтр
  8. Что почитать после состава ответа

Описание инфоблока и его свойств

GET /api/iblock/{код} возвращает описание инфоблока и список его свойств. Отсюда витрина берёт названия и типы свойств для вывода и для построения фильтра:

bash
curl "https://example.ru/api/iblock/reviews"
json
{
    "iblock": {
        "id": 11,
        "type": null,
        "code": "reviews",
        "name": "Отзывы",
        "picture": null,
        "description": "",
        "descriptionType": "text",
        "properties": {
            "product": {
                "id": 45,
                "name": "Товар",
                "code": "PRODUCT",
                "sort": 500,
                "propertyType": "E",
                "userType": null,
                "multiple": "N",
                "feature": ["DETAIL_PAGE_SHOW", "LIST_PAGE_SHOW"],
                "filterHint": null,
                "linkIblockId": 2,
                "linkIblockApiCode": "catalog"
            },
            "rate": {
                "id": 46,
                "name": "Оценка",
                "code": "RATE",
                "propertyType": "N",
                "multiple": "N"
            }
        }
    }
}

Ключ в properties — символьный код свойства в camelCase (MORE_PHOTO -> morePhoto), он же ключ в properties элемента. propertyType — тип свойства Битрикса (S строка, N число, L список, E привязка к элементу, F файл), multiple — "Y" / "N". У свойств-привязок linkIblockApiCode указывает инфоблок, на который они ссылаются. feature — на каких местах вывода свойство отмечено (см. ниже).

Наборы: где и что выводится

Один элемент выводится в четырёх местах, и в каждом нужен свой состав. Поэтому у инфоблока четыре набора:

НаборГде применяется
СписокGET /api/iblock/{код}/elements: карточки в списках
ДетальнаяGET /api/iblock/{код}/elements/{ID или код}: страница элемента
Вложенныйэлемент, на который ссылается свойство-привязка другого элемента (например, «Лейблы» в товаре)
Корзина и заказтовар в корзине и заказе

Набор — это чипы трёх групп: Поля (ID, название, анонс, картинки, даты и др.), Свойства и Служебное (раздел, списки пользователя). У секций свои наборы «Секция» и «Секции».

Как настроить состав ответа

Настройки модуля -> вкладка «Инфоблоки» -> инфоблок слева -> таб «Элементы» -> набор. Нажмите «+» в нужной группе и выберите чипы, лишние уберите крестиком. Внизу рамки инфоблока — «Сохранить настройки инфоблока» (отдельно от общей кнопки «Сохранить» модуля). Любое сохранение сбрасывает кеш API: изменения видны в ответе сразу.

Наборы инфоблока

Пока набор не сохранён, ответ такой же, как до настройки. «Параметры вывода» набора задают, отдавать ли свойства полностью и картинки в оригинале. Экспорт и импорт настроек — кнопки над списком инфоблоков.

Пример: список элементов

bash
curl "https://example.ru/api/iblock/catalog/elements?limit=1"
json
{
    "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 }
            }
        }
    ],
    "pagen": { "total": 10038, "limit": 1, "offset": 0 }
}

Что вошло в data, определяет набор «Список». Если нужно другое поле — добавьте чип и сохраните, менять код не требуется. Своё поле элемента (не из Битрикса) — Поля элемента.

Да / нет и параметры

Все логические значения API — "Y" / "N" (формат Битрикса): active, selected у предложения, multiple у свойств. Параметры Y / N принимают только эти значения, иное значение — ошибка 400 «Параметр <имя>: ожидается Y или N». В JS сравнивайте явно: element.active === 'Y'.

Свои элементы: own=Y

GET /api/iblock/{код}/elements?own=Y возвращает только элементы текущего пользователя, включая неактивные. Гость получает пустой список: {"data": [], "pagen": {"total": 0, "limit": 10, "offset": 0}}. Ответ не кешируется. Подробнее — Личные данные в инфоблоке.

Секции и умный фильтр

  • GET /api/iblock/{код}/sections — дерево секций; withCount=Y добавляет число элементов, withElements=Y — элементы секции.
  • GET /api/iblock/{код}/sections/{ID или код} — карточка секции.
  • GET /api/iblock/{код}/smartFilter — свойства и значения для фильтра со счётчиками.

Эти методы включаются на табе «Секции и фильтр» инфоблока; выключенный отвечает 404. Подробно: Секции инфоблока и Умный фильтр. Общий обзор методов — Инфоблок.

Что почитать после состава ответа

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

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

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