Løs en enkelt rute via URL-sti med parametrisk matchning og validerede parameterdokumenter.
Løs en enkelt rute for en given sti. Et nøjagtigt sti-match vinder; ellers vælges det parametriske mønster med den højeste score, dets bundne parametre valideres mod dokumenter, og de effektive blokke beregnes. Returnerer valgfrit de opløste parameterdokumenter.
Godkendelse: API-nøgle (x-api-key-header eller api_key-forespørgselsparameter).
| Parameter | Type | Påkrævet | Noter |
|---|---|---|---|
websiteId | uuid | ja | Målwebsted. |
path | string | ja | URL-sti der skal løses, f.eks. /docs/getting-started. |
api_key | string | nej | Alternativ til x-api-key-headeren. |
preview | boolean | nej | Standard false. Når true, løses der mod kladdeindhold og kræver ikke publicerede dokumenter. |
skipValidation | boolean | nej | Standard false. Når true, medfører parametervalideringsfejl ikke 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 har samme form som en post fra GET /routes. resolvedParams er kun til stede, når ruten har parameterbindinger og mindst ét dokument er løst. Parametre bundet til language-skemaet løses mod en indbygget liste over understøttede sprog i stedet for databasen.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — manglende/ugyldig websiteId, eller manglende/tom path401 — ugyldig API-nøgle404 — rute ikke fundet, eller parametervalidering mislykkedes (medmindre skipValidation=true)