Как подготовить пользовательский шаблон

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

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

Пользовательский шаблон создают на основе готового сайта или страницы из раздела Сайты. Затем шаблон экспортируют и регистрируют методами раздела landing.demos.* из приложения Битрикс24.

Эта страница описывает общий порядок работы. Она показывает, как подготовить исходный сайт, как получить экспорт и что передать в методы раздела landing.demos.*.

Когда использовать пользовательский шаблон

Используйте пользовательский шаблон, если нужно:

  • добавить собственный шаблон в мастер создания сайтов
  • распространять готовый сайт или страницу через приложение
  • повторно использовать один и тот же набор страниц, блоков и настроек

Если шаблон нужно только установить в одном Битрикс24 без повторного использования, достаточно создать и настроить сайт или страницу обычным способом.

Если шаблон распространяется как приложение с сайтом, смотрите статьи Установка шаблонов сайтов и Требования к сайтам перед публикацией.

Как устроен пользовательский шаблон

Пользовательский шаблон создают на основе существующего сайта из раздела Сайты. Для регистрации шаблона нужно:

  1. Подготовить сайт и страницы
  2. Экспортировать сайт методом landing.site.fullExport
  3. Передать экспортированный массив в landing.demos.register

После регистрации шаблон появляется в мастере создания сайта или страницы.

Список зарегистрированных шаблонов можно получить методом landing.demos.getList. Отдельные списки шаблонов возвращают методы landing.demos.getSiteList для сайтов и landing.demos.getPageList для страниц.

Как подготовить шаблон

Перед экспортом проверьте сам сайт:

  • страницы связаны между собой корректно
  • используются нужные блоки и темы
  • изображения и внешние ресурсы доступны по рабочим URL
  • название, описание и preview-данные подготовлены для шаблона

Если сайт многостраничный, используйте одну тему для всех страниц. Это помогает сохранить единый внешний вид после установки шаблона.

Как зарегистрировать шаблон

Минимальный порядок такой:

  1. Создайте сайт или страницу, которые станут основой шаблона
  2. Экспортируйте сайт методом landing.site.fullExport
  3. Сохраните результат экспорта на стороне приложения
  4. При установке приложения передайте экспортированный массив в landing.demos.register
  5. Проверьте, что шаблон появился в мастере создания сайта или страницы

Обычно в landing.demos.register передают результат landing.site.fullExport без ручной перестройки структуры.

Если нужно изменить название, описание, preview или локализацию, эти значения задают в параметрах экспорта и регистрации.

После регистрации шаблон можно проверить методом landing.demos.getList.

Что учитывать перед регистрацией

Тип шаблона. В данных шаблона используются поля type и tpl_type. Они задают тип шаблона и место его использования в мастере. Проверьте эти поля в структуре, которую вы передаете в landing.demos.register.

Состав экспорта. Обычно в регистрацию передают полный результат landing.site.fullExport. Если структуру меняют вручную, нужно проверить, что в ней сохранены обязательные поля и карта страниц items.

Preview-данные. Подготовьте preview, preview2x, preview3x и preview_url, если шаблон должен отображаться в списке и в предпросмотре.

Внешний код шаблона. Для удаления шаблона нужен его внешний код из поля XML_ID. Получить его можно методом landing.demos.getList. Метод landing.demos.unregister удаляет записи по этому коду внутри текущего приложения. Если шаблон сайта и шаблон страницы зарегистрированы с одним и тем же кодом, удаление может затронуть обе связанные записи.

URL предпросмотра

preview_url задает страницу предпросмотра шаблона в мастере. Этот URL можно передать при экспорте сайта через landing.site.fullExport. Затем его используют при регистрации шаблона.

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

Следите, чтобы ссылка предпросмотра оставалась доступной. Иначе в мастере не откроется страница предпросмотра.

Изображения и внешние ресурсы

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

Если шаблон распространяется в другие Битрикс24, заранее проверьте:

  • что все URL доступны извне
  • что изображения не зависят от временного хранилища
  • что preview-картинки не будут удалены

Локализация шаблона

Название и описание шаблона можно локализовать при регистрации. Для этого в landing.demos.register используют параметры lang и lang_original.

Если шаблон должен отображаться в Битрикс24 с разными языками, подготовьте локализационный массив заранее. Подробности смотрите в статье Локализация шаблона.

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

Предыдущая
Обзор методов
Следующая
Локализация