Razreši posamezno pot po poti URL s parametričnim ujemanjem in potrjenimi dokumenti parametrov.
Razreši posamezno pot za podano pot URL. Če obstaja natančno ujemanje poti, ima to prednost; sicer se izbere parametrični vzorec z najvišjo oceno, njegovi vezani parametri se preverijo glede na dokumente in izračunajo se učinkoviti bloki. Po potrebi vrne razrešene dokumente parametrov.
Avtentikacija: Ključ API (x-api-key glava ali api_key parameter poizvedbe).
| Parameter | Vrsta | Zahtevano | Opombe |
|---|---|---|---|
websiteId | uuid | da | Ciljno spletno mesto. |
path | string | da | Pot URL, ki jo je treba razrešiti, npr. /docs/getting-started. |
api_key | string | ne | Alternativa glavi x-api-key. |
preview | boolean | ne | Privzeto false. Ko je true, se razrešuje na osnutke vsebine in ne zahteva objavljenih dokumentov. |
skipValidation | boolean | ne | Privzeto false. Ko je true, neuspehi preverjanja parametrov ne sprožijo 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 ima enako obliko kot vnos iz GET /routes. resolvedParams je prisoten samo, kadar ima pot povezave parametrov in je razrešen vsaj en dokument. Parametri, vezani na shemo language, se razrešijo z vgrajenim seznamom podprtih jezikov namesto z zbirko podatkov.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — manjkajoč/neveljaven websiteId ali manjkajoča/prazna path401 — neveljaven ključ API404 — pot ni najdena ali preverjanje parametra ni uspelo (razen če skipValidation=true)