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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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"
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ManifestFileResult = {
  block?: Record<string, unknown>
  cards?: Record<string, unknown>
  nodes?: Record<string, unknown>
  style?: Record<string, unknown>
  attrs?: Record<string, unknown>
  assets?: Record<string, unknown>
  menu?: Record<string, unknown>
}

try {
  const response = await $b24.actions.v2.call.make<ManifestFileResult>({
    method: 'landing.block.getmanifestfile',
    params: {
      code: '01.big_with_text',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.block, result.nodes)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getManifestFile() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'landing.block.getmanifestfile',
        params: {
          code: '01.big_with_text',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.block, result.nodes)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getManifestFile)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.block.getmanifestfile(
        code="01.big_with_text",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.block.getmanifestfile", b24.Params{
	"code": "01.big_with_text",
})
if err != nil {
	return fmt.Errorf("landing.block.getmanifestfile: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))

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

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
string

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

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

Код

Описание

MISSING_PARAMS

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

ACCESS_DENIED

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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