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

Превью страницы

GET /v1/pages/:id/preview

Относительный путь превращается в абсолютный по хосту портала. Файла изображения может не быть. Метод не скачивает изображение.

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

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

Поле Тип Обяз. Описание
id integer да ID страницы из списка страниц.
scope string нет Query: KNOWLEDGE, GROUP или MAINPAGE; для обычного сайта не передавайте.

Примеры

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/pages/42/preview" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/pages/42/preview" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/42/preview", {
  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/pages/42/preview", {
  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 object Результат операции.
data.previewUrl string Адрес изображения; файл может отсутствовать.
JSON 
{
  "success": true,
  "data": {
    "previewUrl": "https://example.bitrix24.site/preview.jpg"
  }
}

Ошибки

HTTP Code Условие
400 INVALID_PAGE_ID id не положительное безопасное целое.
400 INVALID_PARAMS Неверная форма тела или значения параметров.
400 INVALID_SCOPE Неверный scope.
401 TOKEN_MISSING Нет учётных данных Б24.
403 SCOPE_DENIED У ключа нет landing.
403 BITRIX_ACCESS_DENIED Нет прав у пользователя Б24.
404 ENTITY_NOT_FOUND Страница не найдена.
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."
  }
}

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