Получить файл манифеста блока landing.block.getmanifestfile

Scope: landing

Кто может выполнять метод: пользователь с доступом к разделу «Сайты и магазины»

Метод landing.block.getmanifestfile возвращает исходный манифест блока из файлового репозитория.

В отличие от landing.block.getmanifest, метод возвращает манифест в исходном виде — так, как он указан в файле .description.php. Он не добавляет служебные поля, например code, preview, timestamp.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

code*
string

Код блока из файлового репозитория.

Можно передать короткий код, например 01.big_with_text. ВТогда метод будет искать блок только в пространстве имен bitrix и автоматически добавит префикс bitrix:.

Если нужен блок из другого пространства имен, передайте полный код в формате <namespace>:<code>.

В коде можно использовать только латинские буквы, цифры и символы . _ - :

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getmanifestfile.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getmanifestfile.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getmanifestfile',
        		{
        			code: '01.big_with_text'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.getmanifestfile',
                    [
                        'code' => '01.big_with_text',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting block manifest file: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getmanifestfile',
            {
                code: '01.big_with_text'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getmanifestfile',
            [
                'code' => '01.big_with_text',
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "block": {
                    "name": "Обложка с меняющимися на фоне картинками",
                    "section": [
                        "cover"
                    ],
                    "dynamic": false
                },
                "cards": {
                    ".landing-block-card-img": {
                        "name": "Фоновая картинка",
                        "label": [
                            ".landing-block-card-img"
                        ]
                    }
                },
                "nodes": {
                    ".landing-block-node-small-title": {
                        "name": "Подзаголовок",
                        "type": "text"
                    },
                    ".landing-block-node-title": {
                        "name": "Заголовок",
                        "type": "text"
                    },
                    ".landing-block-node-text": {
                        "name": "Текст",
                        "type": "text"
                    },
                    ".landing-block-node-button": {
                        "name": "Кнопка",
                        "type": "link"
                    },
                    ".landing-block-card-img": {
                        "name": "Фоновая картинка",
                        "type": "img",
                        "dimensions": {
                            "width": 1920,
                            "height": 1080
                        },
                        "allowInlineEdit": false,
                        "useInDesigner": false,
                        "create2xByDefault": false
                    }
                },
                "style": {
                    "block": {
                        "type": [
                            "display"
                        ],
                        "additional": {
                            "name": "Слайдер",
                            "attrsType": [
                                "autoplay",
                                "autoplay-speed",
                                "pause-hover",
                                "dots"
                            ]
                        }
                    },
                    "nodes": {
                        ".landing-block-node-text-container": {
                            "title": "Набор элементов",
                            "type": [
                                "background-color",
                                "animation"
                            ]
                        },
                        ".landing-block-node-small-title": {
                            "title": "Подзаголовок",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-title": {
                            "title": "Заголовок",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-text": {
                            "title": "Текст",
                            "type": "typo"
                        },
                        ".landing-block-node-button": {
                            "title": "Кнопка",
                            "type": "button"
                        },
                        ".landing-block-card-img": {
                            "name": "Фоновая картинка",
                            "type": [
                                "background-overlay",
                                "height-vh"
                            ]
                        }
                    }
                },
                "assets": {
                    "ext": [
                        "landing_carousel"
                    ]
                }
            },
            "time": {
                "start": 1774521452,
                "finish": 1774521452.955493,
                "duration": 0.9554929733276367,
                "processing": 0,
                "date_start": "2026-03-26T13:37:32+03:00",
                "date_finish": "2026-03-26T13:37:32+03:00",
                "operating_reset_at": 1774522052,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object | array

Исходный манифест блока из файлового репозитория.

Общий формат файла манифеста описан в статье Файл манифеста.

Если блок не найден, код содержит недопустимые символы или передан код локального репозиторного блока вида repo_<ID>, метод вернет пустой массив [] без ошибки

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

block
object

Описание блока из раздела block файла манифеста. Обычно содержит поля: name, section, dynamic, type, system, description, version, id, only_for_license

cards
object | array

Описание карточек блока, если они есть

nodes
object | array

Описание редактируемых узлов блока

style
object | array

Описание доступных настроек стилей блока в том виде, в котором они объявлены в манифесте

attrs
object | array

Описание настраиваемых атрибутов блока, если они заданы

assets
object

Ресурсы, явно объявленные в манифесте блока.

Например, в ответ может прийти assets.ext, если расширения объявлены прямо в .description.php

menu
object | array

Описание меню блока, если оно есть

В result могут быть и другие ключи. Их состав зависит от конкретного блока и содержимого манифеста.

Во вложенных объектах, например nodes, cards и style.nodes, набор полей тоже зависит от конкретного блока. Метод возвращает эти данные в исходном виде, поэтому в одном блоке может использоваться поле title, а в другом name.

Локализуемые названия и подписи метод возвращает на языке портала, если они заданы в манифесте через языковые файлы.

Обработка ошибок

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: code"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр code

ACCESS_DENIED

Доступ запрещен: у пользователя нет доступа к разделу «Сайты и магазины»

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить манифест блока
Следующая
Получить список блоков из репозитория