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 /dataset/{schema_name}

שלפו מסמכים שפורסמו עבור סכימה — את כולם, אחד, אצווה או עמוד — כמערך JSON מוזרם.

שלפו מסמכים שפורסמו עבור סכימה — את כולם, מסמך יחיד, אצווה לפי מזהים או עמוד — מוזרמים כמערך JSON. זמין גם ב-/schemas/{schema_name}. הפניות לתמונות נפתרות לכתובות URL, וכאשר language מוגדר התרגום התואם ממוזג מעל התוכן הבסיס.

Auth: מפתח API. נדרש מפתח רק כאשר השרת מגדיר require_schema_api_key = true; אחרת מתאפשרות קריאות אנונימיות.

פרמטרי נתיב

פרמטרסוגחובההערות
schema_namestringכןסכימת המסמך, למשל post.

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

פרמטרסוגחובההערות
websiteIduuidלאאתר היעד; חוזר לערך בכותרת Host / קונפיגורציה.
iduuidלאשליפת מסמך יחיד. גובר על ids.
idsstringלאמזהי UUID מופרדים בפסיקים (אצווה, מקסימום 200). גובר על עימוד.
languagestringלאממזג את התרגום עבור הלוקייל הזה מעל התוכן הבסיסי.
limitintegerלאגודל עמוד, ברירת המחדל 200, מוגבל ל-200.
offsetintegerלאמספר שורות לדלג (מוחל רק עם limit חיובי).
api_keystringלאחלופה לכותרת x-api-key.

כאשר לא מוגדרים id ולא ids, המסמכים מוחזרים ממוינים לפי published_at DESC.

תגובה

מערך JSON מוזרם. כל איבר הוא התוכן שפורסם של המסמך פרוס ברמה העליונה, בתוספת המפתחות המוזרקים _id, _title ו-_publishedAt:

[
  {
    "_id": "...",
    "_title": "Getting Started",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Getting Started",
    "description": "...",
    "content": "..."
  }
]

שדות התוכן גוברים על המפתחות המוזרקים במקרה של התנגשות. הפניות לתמונות במבנה { alt, _asset: { id } } מקבלות url פתור המוזרק אל _asset.

דוגמה

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

שגיאות

  • 400 — websiteId לא תקין, id לא תקין או ids שגויים (ריקים, יותר מ-200, או UUID לא תקין)
  • 401 — מפתח API לא תקין (או חסר כאשר נדרש)
  • 500 — כשל בשאילתה
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›