Eine einzelne Route anhand des URL-Pfads auflösen, mit parametrischem Matching und validierten Parameterdokumenten.
Eine einzelne Route für einen angegebenen Pfad auflösen. Ein exakter Pfadtreffer hat Vorrang; andernfalls wird das parametrisierte Muster mit der besten Bewertung ausgewählt, seine gebundenen Parameter werden anhand von Dokumenten validiert, und die effektiven Blöcke werden berechnet. Optional werden die aufgelösten Parameterdokumente zurückgegeben.
Auth: API-Schlüssel (x-api-key-Header oder api_key-Query-Parameter).
| Parameter | Typ | Erforderlich | Hinweise |
|---|---|---|---|
websiteId | uuid | ja | Zielwebsite. |
path | string | ja | Aufzulösender URL-Pfad, z. B. /docs/getting-started. |
api_key | string | nein | Alternative zum x-api-key-Header. |
preview | boolean | nein | Standardwert false. Wenn true, erfolgt die Auflösung anhand von Entwurfsinhalten und erfordert keine veröffentlichten Dokumente. |
skipValidation | boolean | nein | Standardwert false. Wenn true, führen Parameter-Validierungsfehler nicht zu 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": "Vereinigte Staaten", "published_content": {} }
}
}
}
route weist dieselbe Struktur wie ein Eintrag von GET /routes auf. resolvedParams ist nur vorhanden, wenn die Route Parameterbindungen hat und mindestens ein Dokument aufgelöst wurde. An das language-Schema gebundene Parameter werden gegen eine integrierte Liste unterstützter Sprachen und nicht gegen die Datenbank aufgelöst.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — fehlende/ungültige websiteId oder fehlender/leerer path401 — ungültiger API-Schlüssel404 — Route nicht gefunden oder Parameterüberprüfung fehlgeschlagen (außer wenn skipValidation=true)