Gauti maršrutą

Išsprendžia vieną maršrutą pagal nurodytą kelią. Tikslus kelio sutapimas laimi; kitu atveju parenkamas geriausiai įvertintas parametrinis šablonas, jo susieti parametrai patikrinami pagal dokumentus ir apskaičiuojami taikomi blokai. Pasirinktinai grąžina išspręstų parametrų dokumentus.

Autentifikacija: API raktas (x-api-key antraštė arba api_key užklausos parametras).

Užklausos parametrai

Atsakymas

{
  "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 turi tą pačią struktūrą kaip įrašas iš GET /routes. resolvedParams pateikiamas tik tada, kai maršrutas turi parametrų susiejimus ir bent vienas dokumentas yra išspręstas. Parametrai, susieti su language schema, sprendžiami pagal įtaisytą palaikomų kalbų sąrašą, o ne pagal duomenų bazę.

Pavyzdys

curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
  -H 'x-api-key: <key>'

Klaidos

• 400 — trūksta/neteisingas websiteId arba trūksta/tuščias path
• 401 — neteisingas API raktas
• 404 — maršrutas nerastas arba nepavyko parametrų tikrinimas (išskyrus atvejį, kai skipValidation=true)