Resolve uma única rota por caminho de URL, com correspondência paramétrica e documentos de parâmetros validados.
Resolve uma única rota para um caminho fornecido. Uma correspondência exata do caminho vence; caso contrário, o padrão paramétrico com melhor pontuação é selecionado, seus parâmetros vinculados são validados em relação aos documentos e os blocos efetivos são calculados. Opcionalmente, retorna os documentos de parâmetros resolvidos.
Autenticação: Chave de API (cabeçalho x-api-key ou parâmetro de consulta api_key).
| Parâmetro | Tipo | Obrigatório | Observações |
|---|---|---|---|
websiteId | uuid | sim | Site de destino. |
path | string | sim | Caminho de URL a ser resolvido, por exemplo /docs/getting-started. |
api_key | string | não | Alternativa ao cabeçalho x-api-key. |
preview | boolean | não | Padrão false. Quando true, resolve com base no conteúdo em rascunho e não exige documentos publicados. |
skipValidation | boolean | não | Padrão false. Quando true, falhas de validação de parâmetros não retornam 404. |
{
"route": {
"path": "/docs/us/guide",
"pattern": "/docs/{country}/guide",
"block_ids": ["..."],
"state": "Ativa",
"param_bindings": { "country": "país" }
},
"resolvedParams": {
"country": {
"value": "us",
"schemaName": "país",
"document": { "id": "...", "schema_name": "país", "title": "Estados Unidos", "published_content": {} }
}
}
}
route tem o mesmo formato que uma entrada de GET /routes. resolvedParams está presente apenas quando a rota possui vínculos de parâmetros e pelo menos um documento resolvido. Parâmetros vinculados ao esquema language são resolvidos com base em uma lista integrada de idiomas compatíveis, em vez do banco de dados.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — websiteId ausente/inválido ou path ausente/vazio401 — chave de API inválida404 — rota não encontrada ou validação de parâmetro falhou (a menos que skipValidation=true)