Работа с типами сайтов и скоупами

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

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

Тип сайта определяет, для чего он нужен и как с ним работает Битрикс24. От этого зависит, как создается сайт, какие страницы, блоки и настройки для него доступны и какие методы landing можно использовать. Например, для базы знаний и интернет-магазина доступны разные возможности.

Параметр scope в методах лендингов не связан с REST-скоупом landing, который вы выдаете приложению или вебхуку

Что важно знать

  • Для типов PAGE, STORE и SMN параметр scope не нужен
  • Для KNOWLEDGE, GROUP и MAINPAGE нужно передавать верхнеуровневый параметр scope
  • Если scope не передан, методы работают только с типами PAGE, STORE и SMN
  • Значение scope должно совпадать с типом сайта или со значением фильтра по типу
  • Скоуп влияет не только на список сайтов и страниц, но и на набор доступных блоков и настроек сайта
  • Тип GROUP доступен только на порталах, где поддерживаются базы знаний групп

Типы сайтов

Тип

Описание

scope в REST-запросе

PAGE

Обычный сайт

Не передавать

STORE

Магазин

Не передавать

SMN

Сайт раздела Сайты24 в 1С-Битрикс: Управление сайтом

Не передавать

KNOWLEDGE

База знаний

KNOWLEDGE

GROUP

База знаний группы

GROUP

MAINPAGE

Главная страница или вайб

MAINPAGE

Как работает scope

Без параметра scope REST-методы работают в стандартном режиме и видят только сайты типов PAGE, STORE и SMN. Если передать scope, методы переключаются на соответствующий тип сайтов. Например, при scope = "KNOWLEDGE" списки сайтов, страницы, права и доступные блоки будут работать только для баз знаний.

scope в запросе

С какими типами сайтов работают методы

Когда использовать

Публичный путь

не передавать

PAGE, STORE, SMN

Обычные сайты и магазины

зависит от домена и настроек сайта

KNOWLEDGE

KNOWLEDGE

Базы знаний

/knowledge/

GROUP

GROUP

Базы знаний групп

/knowledge/group/

MAINPAGE

MAINPAGE

Главная страница и вайб

/vibe/

Если создаете сайт, значение scope должно совпадать с fields.TYPE. Если получаете список сайтов или страниц, значение scope должно совпадать со значением фильтра по типу.

Что меняется в специальных скоупах

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

Скоуп

Что меняется для пользователя

KNOWLEDGE

Методы работают только с базами знаний. Часть настроек сайта недоступна, например SEO-поля, аналитика, пиксели, пользовательский код, favicon, баннер cookies, виджет Битрикс24, настройки каталога и оптимизации

GROUP

Методы работают только с базами знаний групп. Ограничения по настройкам такие же, как у KNOWLEDGE

MAINPAGE

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

Как передавать scope в REST

Для обычных сайтов параметр scope не нужен:

{
            "params": {
                "filter": {
                    "TYPE": "PAGE"
                }
            }
        }

Для базы знаний передавайте верхнеуровневый scope:

{
            "scope": "KNOWLEDGE",
            "params": {
                "filter": {
                    "TYPE": "KNOWLEDGE"
                }
            }
        }

При создании специального типа сайта scope и fields.TYPE должны совпадать:

{
            "scope": "MAINPAGE",
            "fields": {
                "TITLE": "Главная страница компании",
                "CODE": "mainpage",
                "TYPE": "MAINPAGE"
            }
        }

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

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