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

الحصول على المكونات

سرد ملخصات المكونات المخصصة (مخطط نوع المحتوى) لموقع إلكتروني.

سرد ملخصات المكونات المخصصة (مخطط نوع المحتوى) لموقع إلكتروني، مرتبة حسب الاسم. تُعاد المخططات المخصصة التي يعرّفها المستخدم فقط.

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

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

المعاملالنوعمطلوبملاحظات
websiteIduuidنعميجب أن يكون UUID صالحًا. لا يوجد بديل Host/config في نقطة النهاية هذه.
statestringلاعامل تصفية حسب حالة دورة الحياة: draft، active، أو archived.
api_keystringلابديل لترويسة x-api-key.

الاستجابة

مصفوفة JSON تحتوي على ملخصات المكونات:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "منشور",
    "description": "منشور توثيقي",
    "category": "مخصص",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source تكون دائمًا "custom". يعتمد displayName على name، ويكون category افتراضيًا "Custom" عند عدم تعيينه.

مثال

curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
  -H 'x-api-key: <key>'

الأخطاء

  • 400 — websiteId مفقود أو غير صالح
  • 401 — مفتاح API غير صالح
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›