Risolve un singolo percorso in base al percorso URL, con corrispondenza parametrica e documenti dei parametri convalidati.
Risolve un singolo percorso per un path specifico. Una corrispondenza esatta del path ha la precedenza; in caso contrario viene selezionato il pattern parametrico con il punteggio migliore, i parametri associati vengono convalidati rispetto ai documenti e vengono calcolati i blocchi effettivi. Facoltativamente restituisce i documenti dei parametri risolti.
Autenticazione: Chiave API (intestazione x-api-key o parametro di query api_key).
| Parametro | Tipo | Obbligatorio | Note |
|---|---|---|---|
websiteId | uuid | sì | Sito web di destinazione. |
path | string | sì | Path URL da risolvere, ad es. /docs/getting-started. |
api_key | string | no | Alternativa all'intestazione x-api-key. |
preview | boolean | no | Predefinito false. Quando è true, esegue la risoluzione sui contenuti in bozza e non richiede documenti pubblicati. |
skipValidation | boolean | no | Predefinito false. Quando è true, gli errori di convalida dei parametri non restituiscono 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": {} }
}
}
}
Il campo route ha la stessa struttura di una voce restituita da GET /routes. resolvedParams è presente solo quando il percorso ha parametri associati e almeno un documento è stato risolto. I parametri associati allo schema language vengono risolti rispetto a un elenco integrato di lingue supportate invece che al database.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — websiteId mancante/non valido oppure path mancante/vuoto401 — chiave API non valida404 — percorso non trovato oppure la convalida dei parametri non è riuscita (a meno che skipValidation=true)