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

GET /components/{name}

اجلب التعريف الكامل لحقول مكوّن مخصص واحد بالاسم.

اجلب التعريف الكامل لمكوّن مخصص واحد بالاسم، بما في ذلك قائمة حقوله.

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

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

المعاملالنوعإلزاميملاحظات
namestringنعماسم المخطط، مثل post.

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

المعاملالنوعإلزاميملاحظات
websiteIduuidنعميجب أن يكون UUID صالحًا.
api_keystringلابديل عن ترويسة x-api-key.

الاستجابة

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "منشور توثيقي",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

يتم احتساب slugFields — وهي أسماء جميع الحقول من النوع string.

مثال

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

الأخطاء

  • 400 — websiteId مفقود أو غير صالح
  • 401 — مفتاح API غير صالح
  • 404 — لم يتم العثور على المخطط
Continue Reading
Previous‹الحصول على المكوناتNextالحصول على اسم مخطط مجموعة البيانات›