Oldjon fel egyetlen útvonalat URL-útvonal alapján, paraméteres egyezéssel és validált paraméterdokumentumokkal.
Felold egy adott útvonalhoz tartozó egyetlen útvonalat. A pontos útvonal-egyezés élvez elsőbbséget; ellenkező esetben a legmagasabb pontszámú paraméteres mintát választja ki, a hozzárendelt paramétereket dokumentumok alapján validálja, és kiszámítja a tényleges blokkokat. Opcionálisan visszaadja a feloldott paraméterdokumentumokat.
Hitelesítés: API-kulcs (x-api-key fejléc vagy api_key lekérdezési paraméter).
| Paraméter | Típus | Kötelező | Megjegyzés |
|---|---|---|---|
websiteId | uuid | igen | Célwebhely. |
path | string | igen | Feloldandó URL-útvonal, pl. /docs/getting-started. |
api_key | string | nem | Alternatíva az x-api-key fejlécre. |
preview | boolean | nem | Alapérték: false. Ha true, vázlattartalom alapján oldja fel, és nem igényel közzétett dokumentumokat. |
skipValidation | boolean | nem | Alapérték: false. Ha true, a paramétervalidációs hibák nem eredményeznek 404-et. |
{
"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": {} }
}
}
}
A route mező felépítése megegyezik a GET /routes végpont bejegyzésével. A resolvedParams csak akkor jelenik meg, ha az útvonal paraméterkötéseket tartalmaz, és legalább egy dokumentum feloldódott. A language sémához kötött paraméterek egy beépített, támogatott nyelveket tartalmazó listán keresztül oldódnak fel, nem pedig az adatbázisban.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — hiányzó/érvénytelen websiteId, vagy hiányzó/üres path401 — érvénytelen API-kulcs404 — az útvonal nem található, vagy a paramétervalidáció meghiúsult (kivéve, ha skipValidation=true)