FaststÀll en enskild rutt via en URL-sökvÀg med parametrisk matchning och validerade parameterdokument.
FaststÀll en enskild rutt för en angiven sökvÀg. En exakt sökvÀgsmatchning vinner; annars vÀljs det parametriska mönster som har högst poÀng, dess bundna parametrar valideras mot dokument och de effektiva blocken berÀknas. Returnerar vid behov de upplösta parameterdokumenten.
Autentisering: API-nyckel (x-api-key-header eller api_key-frÄgeparameter).
| Parameter | Typ | Obligatorisk | Anteckningar |
|---|---|---|---|
websiteId | uuid | ja | MÄlwebbplats. |
path | string | ja | URL-sökvÀg att lösa upp, t.ex. /docs/getting-started. |
api_key | string | nej | Alternativ till x-api-key-headern. |
preview | boolean | nej | StandardvÀrde false. NÀr true löses mot utkastinnehÄll och publicerade dokument krÀvs inte. |
skipValidation | boolean | nej | StandardvÀrde false. NÀr true leder misslyckade parametervalideringar inte till 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": "Förenta staterna", "published_content": {} }
}
}
}
route har samma struktur som en post frÄn GET /routes. resolvedParams finns bara nÀr rutten har parameterbindningar och minst ett dokument har lösts. Parametrar som Àr bundna till schemat language löses mot en inbyggd lista över sprÄk som stöds i stÀllet för mot databasen.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 â saknat/ogiltigt websiteId, eller saknad/tom path401 â ogiltig API-nyckel404 â rutt hittades inte, eller parametervalidering misslyckades (om inte skipValidation=true)