URL पथ द्वारा एकल रूट हल करें, पैरामीट्रिक मिलान और सत्यापित पैरामीटर दस्तावेज़ों सहित।
किसी दिए गए पथ के लिए एकल रूट हल करें। सटीक पथ मेल होने पर वह प्राथमिकता से चुना जाता है; अन्यथा सर्वोच्च स्कोर वाला पैरामीट्रिक पैटर्न चुना जाता है, उसके बाउंड पैरामीटर दस्तावेज़ों के विरुद्ध सत्यापित किए जाते हैं, और प्रभावी ब्लॉक गणना किए जाते हैं। ऐच्छिक रूप से समाधान किए गए पैरामीटर दस्तावेज़ लौटाता है।
प्रमाणीकरण: API कुंजी (x-api-key हेडर या api_key क्वेरी पैरामीटर)।
| पैरामीटर | प्रकार | आवश्यक | नोट्स |
|---|---|---|---|
websiteId | uuid | हाँ | लक्षित वेबसाइट। |
path | string | हाँ | हल करने के लिए URL पथ, उदाहरण के लिए /docs/getting-started। |
api_key | string | नहीं | x-api-key हेडर का विकल्प। |
preview | boolean | नहीं | डिफ़ॉल्ट false। जब true हो, तो ड्राफ्ट सामग्री के आधार पर हल करता है और प्रकाशित दस्तावेज़ों की आवश्यकता नहीं होती। |
skipValidation | boolean | नहीं | डिफ़ॉल्ट 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 अनुपलब्ध/अमान्य, या path अनुपलब्ध/रिक्त401 — अमान्य API कुंजी404 — रूट नहीं मिला, या पैरामीटर सत्यापन विफल (जब तक skipValidation=true न हो)