Los een enkele route op via een URL-pad, met parametrische matching en gevalideerde parameterdocumenten.
Los een enkele route op voor een opgegeven pad. Een exacte overeenkomst van het pad krijgt voorrang; anders wordt het parametrische patroon met de hoogste score geselecteerd, worden de gekoppelde parameters gevalideerd aan de hand van documenten en worden de effectieve blokken berekend. Geeft optioneel de opgeloste parameterdocumenten terug.
Auth: API-sleutel (x-api-key-header of api_key-queryparameter).
| Parameter | Type | Vereist | Opmerkingen |
|---|---|---|---|
websiteId | uuid | ja | Doelwebsite. |
path | string | ja | URL-pad om op te lossen, bijv. /docs/getting-started. |
api_key | string | nee | Alternatief voor de x-api-key-header. |
preview | boolean | nee | Standaard false. Wanneer true, wordt er opgelost tegen conceptinhoud en zijn gepubliceerde documenten niet vereist. |
skipValidation | boolean | nee | Standaard false. Wanneer true, leiden fouten bij parametervalidatie niet tot een 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 heeft dezelfde vorm als een item uit GET /routes. resolvedParams is alleen aanwezig wanneer de route parameterbindingen heeft en er minstens één document is opgelost. Parameters die aan het language-schema zijn gekoppeld, worden opgelost aan de hand van een ingebouwde lijst met ondersteunde talen in plaats van de database.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — ontbrekende/ongeldige websiteId, of ontbrekend/leeg path401 — ongeldige API-sleutel404 — route niet gevonden, of parametervalidatie mislukt (tenzij skipValidation=true)