Atrisina vienu maršrutu pēc URL ceļa ar parametrisko atbilstību un validētiem parametru dokumentiem.
Atrisina vienu maršrutu dotajam ceļam. Ja atrodas precīza ceļa atbilstība, tā uzvar; pretējā gadījumā tiek izvēlēts visaugstāk novērtētais parametriskais raksts, tā piesaistītie parametri tiek validēti pret dokumentiem, un tiek aprēķināti efektīvie bloki. Pēc izvēles atgriež atrisinātos parametru dokumentus.
Autentifikācija: API atslēga (x-api-key galvene vai api_key vaicājuma parametrs).
| Parametrs | Tips | Obligāts | Piezīmes |
|---|---|---|---|
websiteId | uuid | jā | Mērķa tīmekļa vietne. |
path | string | jā | URL ceļš, ko atrisināt, piem., /docs/getting-started. |
api_key | string | nē | Alternatīva x-api-key galvenei. |
preview | boolean | nē | Noklusējums false. Ja true, atrisina pēc melnraksta satura un neprasa publicētus dokumentus. |
skipValidation | boolean | nē | Noklusējums false. Ja true, parametru validācijas kļūmes neizraisa 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 ir tāda pati struktūra kā ierakstam no GET /routes. resolvedParams ir pieejams tikai tad, ja maršrutam ir parametru sasaistes un atrisināts vismaz viens dokuments. Parametri, kas piesaistīti shēmai language, tiek atrisināti pēc iebūvēta atbalstīto valodu saraksta, nevis datubāzes.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — trūkst vai ir nederīgs websiteId, vai trūkst/tukšs path401 — nederīga API atslēga404 — maršruts nav atrasts vai parametru validācija neizdevās (ja vien skipValidation=true)