Визначає окремий маршрут за URL-шляхом із параметричним зіставленням і перевіреними документами параметрів.
Визначає один маршрут для заданого шляху. Точне співпадіння шляху має пріоритет; інакше вибирається параметричний шаблон із найвищим рейтингом, його прив’язані параметри перевіряються відносно документів, а ефективні блоки обчислюються. За потреби повертає розв’язані документи параметрів.
Auth: Ключ API (заголовок x-api-key або параметр запиту api_key).
| Параметр | Тип | Обов’язково | Примітки |
|---|---|---|---|
websiteId | uuid | так | Цільовий вебсайт. |
path | string | так | URL-шлях, який потрібно визначити, напр. /docs/getting-started. |
api_key | string | ні | Альтернатива заголовку x-api-key. |
preview | boolean | ні | Типове значення — false. Якщо true, визначає за чернетковим вмістом і не вимагає опублікованих документів. |
skipValidation | boolean | ні | Типове значення — 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, або відсутній/порожній path401 — некоректний ключ API404 — маршрут не знайдено або перевірка параметрів не пройдена (якщо skipValidation=true, помилка не повертається)