profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

ניתוב פרמטריסוגי רכיביםSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyכתיבת סקריפטים בבונה התבניותProject Scaffoldingספריית המדיה

ללא ראש

התחלה מהירהSplit Screen JSON Component Builder with LLMComponent Zod Pull

ממשק REST

סקירת REST APIgetחיבור-אתר-ל-API-של-CMSgetGET /routesgetGET /routegetקבלת בלוקיםgetהשגת-בלוקים-עם-מטמון-CELgetGET /blocks/generatedgetקבל רכיביםgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postתרגום פוסטpatchPATCH /translationsgetGET /usagepostפוסט-CSVpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

קבל את הגדרת השדות המלאה של רכיב מותאם אישית בודד לפי שם.

קבל את ההגדרה המלאה של רכיב מותאם אישית בודד לפי שם, כולל רשימת השדות שלו.

אימות: מפתח API (כותרת x-api-key או פרמטר השאילתה api_key).

פרמטרי נתיב

פרמטרסוגחובההערות
nameמחרוזתכןשם הסכמה, למשל post.

פרמטרי שאילתה

פרמטרסוגחובההערות
websiteIduuidכןחייב להיות UUID תקין.
api_keyמחרוזתלאחלופה לכותרת x-api-key.

תגובה

{
  "id": "...",
  "name": "פוסט",
  "displayName": "פוסט",
  "description": "פוסט תיעוד",
  "category": "מותאם אישית",
  "titleField": "כותרת",
  "routeSlugField": "כותרת",
  "icon": null,
  "fields": [
    { "name": "כותרת", "type": "מחרוזת", "required": true }
  ],
  "slugFields": ["כותרת", "תיאור"],
  "version": 8
}

slugFields מחושב — שמות כל השדות מסוג מחרוזת.

דוגמה

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

שגיאות

  • 400 — websiteId חסר או שגוי
  • 401 — מפתח API שגוי
  • 404 — הסכמה לא נמצאה
Continue Reading
Previous‹קבל רכיביםNextGET /dataset/{schema_name}›