profound-logoProfound CMS
⌘K
Admin
Theme
Docsبرنامج تعليميBlogPhilosophy
Docsبرنامج تعليميBlogPhilosophy

Hybrid

التوجيه البارامتريTypes of Componentsإس إس إيInstall Profound CMS as a proxyالبرمجة النصية في منشئ القوالبProject Scaffoldingمكتبة الوسائط

بلا رأس

البدء السريعJSON و Claude CodeComponent Zod Pull

واجهة برمجة تطبيقات REST

نظرة عامة على واجهة RESTgetربط موقع الويب بواجهة برمجة التطبيقاتgetالحصول على المساراتgetالحصول على مسارgetالحصول على الكتلgetجلب الكتل مع ذاكرة CEL المؤقتةgetGET /blocks/generatedgetالحصول على المكوناتgetGET /components/{name}getالحصول على اسم مخطط مجموعة البياناتgetالحصول على تغييرات المحتوى (SSE)patchPATCH /dataset/{schema_name}postترجمة المنشورpatchPATCH /translationsgetالحصول على الاستخدامpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

الحصول على مسار

حلّ مسار واحد باستخدام مسار عنوان URL، مع مطابقة بارامترية والتحقق من مستندات المعلمات.

يعمل على حلّ مسار واحد لمسار معيّن. إذا وُجد تطابق تام للمسار فهو المعتمد؛ وإلا يتم اختيار النمط البارامتري الأعلى نتيجة، ثم تُتحقق المعلمات المرتبطة مقارنةً بالمستندات، وتُحسب الكتل الفعّالة. يمكنه أيضًا إرجاع مستندات المعلمات التي تم حلّها بشكل اختياري.

المصادقة: مفتاح API (ترويسة x-api-key أو معامل الاستعلام api_key).

معاملات الاستعلام

المعاملالنوعمطلوبملاحظات
websiteIduuidنعمالموقع المستهدف.
pathstringنعممسار عنوان URL المراد حله، مثل /docs/getting-started.
api_keystringلابديل عن ترويسة x-api-key.
previewbooleanلاالقيمة الافتراضية false. عند ضبطها على true تتم عملية الحل مقابل المحتوى المسود ولا يتطلب مستندات منشورة.
skipValidationbooleanلاالقيمة الافتراضية 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)
Continue Reading
Previous‹الحصول على المساراتNextالحصول على الكتل›