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

קבל רכיבים

הצג תקצירים של רכיבי תוכן מותאמים אישית של אתר.

הצג תקצירים של רכיבים מותאמים אישית (סכמת סוג תוכן) עבור אתר, מסודרים לפי שם. מוחזרות רק סכמות מותאמות אישית שהוגדרו על ידי המשתמש.

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

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

פרמטרסוגחובההערות
websiteIduuidכןחייב להיות UUID תקף. אין נסיגת Host/תצורה בנקודת קצה זו.
statestringלאסינון לפי מצב מחזור חיים: draft, active או archived.
api_keystringלאחלופה לכותרת x-api-key.

תגובה

מערך JSON של תקצירי רכיבים:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "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}›