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

Найти страницу по адресу

GET /v1/pages/resolve

Ищет страницу по пути внутри заданного сайта. Несуществующий сайт или путь без доступной страницы возвращает 404. Если обязательные query-параметры не переданы, ответ — 400. Найденная страница дополнительно проверяется чтением с правами владельца учётных данных.

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

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

Поле Тип Обяз. Описание
scope string нет Query: KNOWLEDGE, GROUP или MAINPAGE; для обычного сайта не передавайте.
siteId integer да Query: сайт из списка сайтов.
path string да Query: путь внутри сайта, например /example/.

Примеры

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/pages/resolve?siteId=10&path=%2Fexample%2F" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/pages/resolve?siteId=10&path=%2Fexample%2F" \
  -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/resolve?siteId=10&path=%2Fexample%2F", {
  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/resolve?siteId=10&path=%2Fexample%2F", {
  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.pageId integer ID найденной страницы.
JSON 
{
  "success": true,
  "data": {
    "pageId": 42
  }
}

Ошибки

HTTP Code Условие
400 MISSING_REQUIRED_FIELDS Не переданы обязательные параметры.
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."
  }
}

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