Получить URL превью сайта landing.site.getPreview

Scope: landing

Кто может выполнять метод: пользователь с правом «просмотр» сайтов

Метод landing.site.getPreview возвращает URL превью индексной страницы сайта.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор сайта.

Идентификатор сайта можно получить с помощью метода landing.site.getList или из результата метода landing.site.add

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 1817
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getPreview.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 1817,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getPreview.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getPreview',
        		{
        			id: 1817
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getPreview',
                    [
                        'id' => 1817,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . $result;
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting site preview: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.getPreview',
            {
                id: 1817
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getPreview',
            [
                'id' => 1817,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo $result['result'];
        }

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

HTTP-статус: 200

{
            "result": "/preview.jpg",
            "time": {
                "start": 1773275667,
                "finish": 1773275667.66318,
                "duration": 0.6631801128387451,
                "processing": 0,
                "date_start": "2026-03-12T03:34:27+03:00",
                "date_finish": "2026-03-12T03:34:27+03:00",
                "operating_reset_at": 1773276267,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
string

URL или относительный путь до изображения превью индексной страницы сайта.

Метод возвращает строку с путем или URL превью. Частые варианты: "/preview.jpg" и "/bitrix/images/landing/nopreview.jpg"

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: id"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

MISSING_PARAMS

error_description

Недостаточно параметров вызова, пропущены: id

400

ACCESS_DENIED

error_description

Недостаточно прав для вызова метода

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Получить список сайтов
Следующая
Получить публичный URL сайта