profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Параметрична маршрутизаціяTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyСкрипти у конструкторі шаблонівProject ScaffoldingMedia Library

Headless

Швидкий стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Огляд REST APIgetПідключення вебсайту до APIgetGET /routesgetGET /routegetGET /blocksgetотримати-блоки-з-CEL-кешемgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПереклад публікаційpatchОновлення перекладівgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Визначає окремий маршрут за URL-шляхом із параметричним зіставленням і перевіреними документами параметрів.

Визначає один маршрут для заданого шляху. Точне співпадіння шляху має пріоритет; інакше вибирається параметричний шаблон із найвищим рейтингом, його прив’язані параметри перевіряються відносно документів, а ефективні блоки обчислюються. За потреби повертає розв’язані документи параметрів.

Auth: Ключ API (заголовок x-api-key або параметр запиту api_key).

Параметри запиту

ПараметрТипОбов’язковоПримітки
websiteIduuidтакЦільовий вебсайт.
pathstringтакURL-шлях, який потрібно визначити, напр. /docs/getting-started.
api_keystringніАльтернатива заголовку x-api-key.
previewbooleanніТипове значення — false. Якщо true, визначає за чернетковим вмістом і не вимагає опублікованих документів.
skipValidationbooleanніТипове значення — false. Якщо true, збої перевірки параметрів не повертають 404.

Відповідь

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Live",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "United States", "published_content": {} }
    }
  }
}

Об’єкт route має ту саму структуру, що й запис із GET /routes. Поле resolvedParams присутнє лише тоді, коли маршрут має прив’язки параметрів і принаймні один документ визначено. Параметри, прив’язані до схеми language, визначаються за вбудованим переліком підтримуваних мов, а не за базою даних.

Приклад

curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
  -H 'x-api-key: <key>'

Помилки

  • 400 — відсутній або некоректний websiteId, або відсутній/порожній path
  • 401 — некоректний ключ API
  • 404 — маршрут не знайдено або перевірка параметрів не пройдена (якщо skipValidation=true, помилка не повертається)
Continue Reading
Previous‹GET /routesNextGET /blocks›