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

جلب الكتل مع ذاكرة CEL المؤقتة

جلب الكتل ودمج سكربتات CEL المُقيَّمة على مستوى الحقول في المحتوى المنشور.

مثل GET /blocks، لكنه يقيّم أيضًا سكربتات CEL على مستوى الحقول المسجَّلة لكل كتلة ويُدمج النتائج في published_content الخاصة بكل كتلة. استخدم هذا عندما تحتوي الكتل على حقول محسوبة.

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

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

المعاملالنوعمطلوبملاحظات
websiteIduuidnoالموقع الهدف؛ يُرجع إلى ترويسة Host / الإعداد الافتراضي.
blockIdsstringnoمعرّفات UUID للكتل مفصولة بفواصل. ملاحظة: blockIds، وليس ids.
routePathstringnoمسار التوجيه لسياق meta الخاص بـCEL.
paramsstringnoكائن JSON مشفَّر بصيغة URL لمعلمات المسار، مثل {"code":"JFK"}.
localestringnoاللغة الخاصة بـmeta.locale وعمليات البحث المترجمة. القيمة الافتراضية en.
api_keystringnoبديل عن ترويسة x-api-key.

الاستجابة

{
  "blocks": [
    {
      "id": "...",
      "schema_name": "hero-block",
      "published_content": {},
      "cached_fields": ["hero.title", "hero.subtitle"]
    }
  ]
}

كل عنصر هو كتلة (نفس الحقول كما في GET /blocks) مع مصفوفة اختيارية cached_fields تسرد المسارات النقطية التي ملأتها CEL. يتم إهمال cached_fields عندما لا يتم احتساب أي شيء. يتم دمج CEL فقط عندما تكون published_content الخاصة بالكتلة غير فارغة.

مثال

curl '{CMS_API_URL}/blocks/with-cel-cache?websiteId=<uuid>&blockIds=<id1>,<id2>&locale=en' \
  -H 'x-api-key: <key>'

الأخطاء

  • 400 — UUID غير صالح في blockIds، أو موقع تعذّر حلّه
  • 401 — مفتاح واجهة برمجة تطبيقات غير صالح
  • 500 — فشل محرك CEL
Continue Reading
Previous‹الحصول على الكتلNextGET /blocks/generated›