Vyrieši jednu trasu podľa cesty URL s parametrickým párovaním a overenými dokumentmi parametrov.
Vyrieši jednu trasu pre zadanú cestu. Presná zhoda cesty má prednosť; inak sa vyberie parametrický vzor s najvyšším skóre, jeho naviazané parametre sa overia voči dokumentom a vypočítajú sa výsledné bloky. Voliteľne vráti vyriešené dokumenty parametrov.
Autorizácia: Kľúč API (x-api-key header alebo dotazovací parameter api_key).
| Parameter | Typ | Povinné | Poznámky |
|---|---|---|---|
websiteId | uuid | áno | Cieľová webová stránka. |
path | reťazec | áno | Cesta URL, ktorú treba vyriešiť, napr. /docs/getting-started. |
api_key | reťazec | nie | Alternatíva k hlavičke x-api-key. |
preview | logická hodnota | nie | Predvolené false. Ak je true, rieši sa voči konceptnému obsahu a nevyžaduje publikované dokumenty. |
skipValidation | logická hodnota | nie | Predvolené false. Ak je true, zlyhania overenia parametrov nespôsobia 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 má rovnaký tvar ako položka z GET /routes. resolvedParams je prítomné iba vtedy, keď má trasa naviazané parametre a vyriešil sa aspoň jeden dokument. Parametre naviazané na schému language sa riešia voči vstavanému zoznamu podporovaných jazykov namiesto databázy.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — chýbajúce/neplatné websiteId alebo chýbajúca/prázdna path401 — neplatný kľúč API404 — trasa sa nenašla alebo zlyhalo overenie parametrov (pokiaľ skipValidation=true)