Получить адрес специальной страницы сайта landing.syspage.getSpecialPage

Scope: landing

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

Метод landing.syspage.getSpecialPage возвращает URL специальной страницы сайта.

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

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

Название
тип

Описание

siteId*
integer

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

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

type*
string

Код специальной страницы, который метод ищет в привязках сайта.

Метод ищет точное совпадение по строке, без обрезки пробелов и без нормализации регистра.

Возможные значения:

  • mainpage — главная страница
  • catalog — главная страница каталога
  • personal — персональный раздел
  • cart — корзина
  • order — оформление заказа
  • payment — страница оплаты
  • compare — страница сравнения
  • feedback — страница обратной связи

Метод landing.syspage.set при сохранении убирает пробелы по краям значения type. Поэтому в landing.syspage.getSpecialPage параметр type нужно передавать без лишних пробелов. Иначе метод может не найти нужную страницу.

Если вместо строки передать число, true, false или null, метод вернет пустую строку "". Если передать массив, запрос завершится ошибкой

additional
object

Дополнительные параметры URL (подробное описание).

Каждая пара ключ-значение добавляется к итоговому URL найденной страницы. По умолчанию — пустой объект

Параметр additional

Параметр additional добавляет к адресу найденной страницы дополнительные параметры. Он не влияет на то, какую страницу вернет метод: страница все равно определяется только по siteId и type.

Передавайте additional как объект в формате {"<имя_параметра>": "<значение>"}. Все переданные параметры будут добавлены в адресс найденной страницы. Если страница не найдена, параметр не применяется. Если в URL уже есть параметр с таким именем, его значение будет заменено.

Пример:

{
            "siteId": 1390,
            "type": "personal",
            "additional": {
                "SECTION": "private",
                "utm_source": "newsletter"
            }
        }

Результат:

https://b24-test.bitrix24.shop/personalnyyrazdel/?SECTION=private&utm_source=newsletter

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1390,
            "type": "personal",
            "additional": {
              "SECTION": "private"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.syspage.getSpecialPage.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1390,
            "type": "personal",
            "additional": {
              "SECTION": "private"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.syspage.getSpecialPage.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.syspage.getSpecialPage',
        		{
        			siteId: 1390,
        			type: 'personal',
        			additional: {
        				SECTION: 'private'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.syspage.getSpecialPage',
                    [
                        'siteId' => 1390,
                        'type' => 'personal',
                        'additional' => [
                            'SECTION' => 'private',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting special page URL: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.syspage.getSpecialPage',
            {
                siteId: 1390,
                type: 'personal',
                additional: {
                    SECTION: 'private'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.syspage.getSpecialPage',
            [
                'siteId' => 1390,
                'type' => 'personal',
                'additional' => [
                    'SECTION' => 'private',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": "https://btest.bitrix24.shop/personalnyyrazdel/?SECTION=private",
            "time": {
                "start": 1774359422,
                "finish": 1774359422.588757,
                "duration": 0.5887570381164551,
                "processing": 0,
                "date_start": "2026-03-24T16:37:02+03:00",
                "date_finish": "2026-03-24T16:37:02+03:00",
                "operating_reset_at": 1774360022,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
string | null

URL специальной страницы.

Если передан additional и страница найдена, параметры будут добавлены в строку запроса.

Метод не проверяет, активна ли страница и не помечена ли она как удаленная. Возвращает null, если сайт не найден или у пользователя нет права «чтение» сайта siteId.

Пустая строка "" возвращается в двух случаях:

  • если для переданного type не найдена привязка,
  • если type передан не строкой и не массивом

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр siteId, type или оба параметра

ACCESS_DENIED

Доступ к вызову метода запрещен: недостаточно прав для работы с разделом Сайты и магазины

ERROR_ARGUMENT

Передан неверный тип данных в параметре siteId, type или additional

SYSTEM_ERROR

Во время выполнения метода возникла внутренняя ошибка

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

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

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

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

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