Επιλύστε μία μόνο διαδρομή βάσει διαδρομής URL, με παραμετρική αντιστοίχιση και επικυρωμένα έγγραφα παραμέτρων.
Επιλύει μία μόνο διαδρομή για ένα συγκεκριμένο μονοπάτι. Μια ακριβής αντιστοίχιση μονοπατιού υπερισχύει· διαφορετικά επιλέγεται το παραμετρικό μοτίβο με την υψηλότερη βαθμολογία, οι δεσμευμένες παράμετροί του επικυρώνονται έναντι των εγγράφων και υπολογίζονται τα τελικά μπλοκ. Προαιρετικά επιστρέφει τα έγγραφα παραμέτρων που επιλύθηκαν.
Auth: Κλειδί API (κεφαλίδα x-api-key ή παράμετρος ερωτήματος api_key).
| Παράμετρος | Τύπος | Υποχρεωτική | Σημειώσεις |
|---|---|---|---|
websiteId | uuid | yes | Ιστότοπος προορισμού. |
path | string | yes | Διαδρομή URL προς επίλυση, π.χ. /docs/getting-started. |
api_key | string | no | Εναλλακτική στην κεφαλίδα x-api-key. |
preview | boolean | no | Προεπιλογή false. Όταν είναι true, γίνεται επίλυση με βάση πρόχειρο περιεχόμενο και δεν απαιτούνται δημοσιευμένα έγγραφα. |
skipValidation | boolean | no | Προεπιλογή false. Όταν είναι true, οι αποτυχίες επικύρωσης παραμέτρων δεν επιστρέφουν 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 έχει την ίδια μορφή με μία καταχώριση από το GET /routes. resolvedParams υπάρχει μόνο όταν η διαδρομή έχει δεσμεύσεις παραμέτρων και έχει επιλυθεί τουλάχιστον ένα έγγραφο. Παράμετροι που δεσμεύονται στο σχήμα language επιλύονται μέσω μιας ενσωματωμένης λίστας υποστηριζόμενων γλωσσών αντί της βάσης δεδομένων.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — λείπει/μη έγκυρο websiteId, ή λείπει/κενό path401 — μη έγκυρο κλειδί API404 — δεν βρέθηκε η διαδρομή ή η επικύρωση παραμέτρων απέτυχε (εκτός αν skipValidation=true)