profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchΡύθμιση διακομιστή μεσολάβησης πίνακα διαχείρισηςCEL Scripting in Template BuilderProject ScaffoldingΒιβλιοθήκη πολυμέσων

Χωρίς κεφαλή

Γρήγορη εκκίνησηjson και Claude κώδικαςComponent Zod Pull

REST API

επισκόπηση του REST APIgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetΛήψη μπλοκ με cel cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getΛήψη ονόματος σχήματος συνόλου δεδομένωνgetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Λήψη ονόματος σχήματος συνόλου δεδομένων

Ανακτήστε δημοσιευμένα έγγραφα για ένα σχήμα — όλα, ένα, μια παρτίδα ή μία σελίδα — ως πίνακα JSON σε ροή.

Ανακτήστε δημοσιευμένα έγγραφα για ένα σχήμα — όλα, ένα μεμονωμένο έγγραφο, μια παρτίδα βάσει ID ή μία σελίδα — που μεταδίδονται ως πίνακας JSON. Διατίθεται επίσης στο /schemas/{schema_name}. Οι αναφορές εικόνων επιλύονται σε URL και όταν έχει οριστεί η language η αντίστοιχη μετάφραση συγχωνεύεται πάνω από το βασικό περιεχόμενο.

Auth: Κλειδί API. Ένα κλειδί απαιτείται μόνο όταν ο διακομιστής ορίσει require_schema_api_key = true· διαφορετικά επιτρέπονται ανώνυμες αναγνώσεις.

Παράμετροι διαδρομής

ΠαράμετροςΤύποςΑπαιτείταιΣημειώσεις
schema_namestringyesΤο σχήμα εγγράφου, π.χ. post.

Παράμετροι ερωτήματος

ΠαράμετροςΤύποςΑπαιτείταιΣημειώσεις
websiteIduuidnoΙστότοπος-στόχος· σε περίπτωση απουσίας χρησιμοποιείται η κεφαλίδα Host / ρύθμιση.
iduuidnoΑνακτά ένα μεμονωμένο έγγραφο. Υπερισχύει του ids.
idsstringnoUUID χωρισμένα με κόμμα (παρτίδα, μέγιστο 200). Υπερισχύει της σελιδοποίησης.
languagestringnoΣυγχωνεύει τη μετάφραση για αυτήν τη γλωσσική ρύθμιση πάνω στο βασικό περιεχόμενο.
limitintegernoΜέγεθος σελίδας, προεπιλογή 200, ανώτατο όριο 200.
offsetintegernoΓραμμές προς παράλειψη (εφαρμόζεται μόνο με θετικό limit).
api_keystringnoΕναλλακτική στην κεφαλίδα x-api-key.

Όταν δεν έχει οριστεί ούτε id ούτε ids, τα έγγραφα επιστρέφονται ταξινομημένα κατά published_at DESC.

Απόκριση

Ένας πίνακας JSON σε ροή. Κάθε στοιχείο είναι το δημοσιευμένο περιεχόμενο του εγγράφου απλωμένο στο ανώτερο επίπεδο, μαζί με εγχεόμενα κλειδιά _id, _title και _publishedAt:

[
  {
    "_id": "...",
    "_title": "Ξεκινώντας",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Ξεκινώντας",
    "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)›