حلّ مسار واحد باستخدام مسار عنوان 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)