Resuelve una única ruta según la ruta de la URL, con coincidencia paramétrica y documentos de parámetros validados.
Resuelve una única ruta para una ruta dada. Una coincidencia exacta de la ruta tiene prioridad; de lo contrario, se selecciona el patrón paramétrico con mejor puntuación, sus parámetros vinculados se validan contra los documentos y se calculan los bloques efectivos. Opcionalmente devuelve los documentos de parámetros resueltos.
Autenticación: Clave de API (encabezado x-api-key o parámetro de consulta api_key).
| Parámetro | Tipo | Obligatorio | Notas |
|---|---|---|---|
websiteId | uuid | sí | Sitio web de destino. |
path | string | sí | Ruta de URL que se va a resolver, p. ej., /docs/getting-started. |
api_key | string | no | Alternativa al encabezado x-api-key. |
preview | boolean | no | Predeterminado false. Cuando es true, resuelve contra contenido en borrador y no requiere documentos publicados. |
skipValidation | boolean | no | Predeterminado false. Cuando es true, los errores de validación de parámetros no devuelven 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 tiene la misma estructura que una entrada de GET /routes. resolvedParams solo está presente cuando la ruta tiene vinculaciones de parámetros y al menos un documento resuelto. Los parámetros vinculados al esquema language se resuelven contra una lista integrada de idiomas admitidos en lugar de la base de datos.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — websiteId faltante o no válido, o path faltante/vacío401 — clave de API no válida404 — ruta no encontrada o validación de parámetros fallida (a menos que skipValidation=true)