GET /route

Lahenda antud teele üks marsruut. Täpne tee vaste võidab; vastasel juhul valitakse kõrgeima skooriga parametreeritud muster, selle seotud parameetrid valideeritakse dokumentide alusel ja arvutatakse kehtivad plokid. Soovi korral tagastatakse lahendatud parameetrite dokumendid.

Autentimine: API võti (x-api-key päis või api_key päringuparameeter).

Päringuparameetrid

Vastus

{
  "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 on sama kujuga nagu kirje päringust GET /routes. resolvedParams on olemas ainult siis, kui marsruudil on parameetrisidumised ja vähemalt üks dokument on lahendatud. Skeemiga language seotud parameetrid lahendatakse andmebaasi asemel sisseehitatud toetatud keelte loendi põhjal.

Näide

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

Veateated

• 400 — puuduv või kehtetu websiteId, või puuduv/tühi path
• 401 — kehtetu API võti
• 404 — marsruuti ei leitud või parameetri valideerimine ebaõnnestus (välja arvatud juhul, kui skipValidation=true)