Для AI-агентов: markdown этой страницы — /docs-content/entities/page-templates.md индекс документации — /llms.txt

Шаблоны страниц

GET /v1/page-templates

Возвращает справочник кодов для создания страницы по шаблону. Код может быть empty или кодом приложения с @. Перед созданием проверьте available и тип сайта.

Требуется скоуп landing. Доступно ключу READONLY.

Параметры запроса

Поле Тип Обяз. Описание
scope string нет Query: KNOWLEDGE, GROUP или MAINPAGE; для обычного сайта не передавайте.
siteType string нет Query: тип шаблона, по умолчанию page; должен соответствовать сайту.

Примеры

curl — личный ключ

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/page-templates?siteType=page" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/page-templates?siteType=page" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const response = await fetch("https://vibecode.bitrix24.tech/v1/page-templates?siteType=page", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth-приложение

javascript 
const response = await fetch("https://vibecode.bitrix24.tech/v1/page-templates?siteType=page", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Поля ответа

Поле Тип Описание
success boolean true
data array Результат операции.
data[].code string Код шаблона.
data[].title string title
data[].description string description
data[].siteType string siteType
data[].available boolean Доступен ли шаблон.
data[].appCode string Необязательный код приложения.
data[].previewUrl string Необязательный адрес изображения; URL с учётными данными редактируется.
JSON 
{
  "success": true,
  "data": [
    {
      "code": "empty",
      "title": "Empty",
      "description": "",
      "siteType": "PAGE",
      "available": true
    }
  ]
}

Ошибки

HTTP Code Условие
400 INVALID_PARAMS Неверная форма тела или значения параметров.
400 INVALID_SCOPE Неверный scope.
401 TOKEN_MISSING Нет учётных данных Б24.
403 SCOPE_DENIED У ключа нет landing.
403 BITRIX_ACCESS_DENIED Нет прав у пользователя Б24.
422 BITRIX_ERROR Бизнес-отказ Б24; текст возвращается без подмены.
422 BITRIX_NO_EFFECT Б24 не подтвердил действие или не вернул ожидаемый результат.

Все системные ошибки.

400 — неверный scope:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_SCOPE",
    "message": "scope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted."
  }
}

Смотрите также