Razriješi jednu rutu prema URL putanji, s parametarskim podudaranjem i provjerenim dokumentima parametara.
Razriješi jednu rutu za zadanu putanju. Točno podudaranje putanje ima prednost; inače se odabire parametarski uzorak s najboljim rezultatom, njegovi vezani parametri provjeravaju se u odnosu na dokumente i izračunavaju se učinkoviti blokovi. Po želji vraća razriješene dokumente parametara.
Autentikacija: API ključ (x-api-key zaglavlje ili api_key upitni parametar).
| Parametar | Vrsta | Obavezno | Napomene |
|---|---|---|---|
websiteId | uuid | da | Ciljana web-stranica. |
path | string | da | URL putanja koju treba razriješiti, npr. /docs/getting-started. |
api_key | string | ne | Alternativa zaglavlju x-api-key. |
preview | boolean | ne | Zadano je false. Kada je true, razrješava se prema nacrtu sadržaja i ne zahtijeva objavljene dokumente. |
skipValidation | boolean | ne | Zadano je false. Kada je true, neuspjesi provjere parametara ne rezultiraju statusom 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": "Sjedinjene Američke Države", "published_content": {} }
}
}
}
route ima isti oblik kao zapis iz GET /routes. resolvedParams je prisutan samo kada ruta ima vezanja parametara i barem jedan dokument razriješen. Parametri vezani uz shemu language razrješavaju se prema ugrađenom popisu podržanih jezika umjesto prema bazi podataka.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — nedostaje/neispravan websiteId ili nedostaje/prazan path401 — nevažeći API ključ404 — ruta nije pronađena ili provjera parametara nije uspjela (osim ako je skipValidation=true)