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

GET /components/{name}

Ανακτήστε τον πλήρη ορισμό πεδίων ενός μεμονωμένου προσαρμοσμένου συστατικού βάσει ονόματος.

Ανακτήστε τον πλήρη ορισμό ενός μεμονωμένου προσαρμοσμένου συστατικού βάσει ονόματος, συμπεριλαμβανομένης της λίστας πεδίων του.

Έλεγχος ταυτότητας: Κλειδί API (x-api-key header ή παράμετρος ερωτήματος api_key).

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

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

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

ΠαράμετροςΤύποςΑπαιτείταιΣημειώσεις
websiteIduuidναιΠρέπει να είναι έγκυρο UUID.
api_keystringόχιΕναλλακτική στην κεφαλίδα x-api-key.

Απόκριση

{
  "id": "...",
  "name": "post",
  "displayName": "Δημοσίευση",
  "description": "Μια δημοσίευση τεκμηρίωσης",
  "category": "Προσαρμοσμένο",
  "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‹GET /componentsNextΛήψη ονόματος σχήματος συνόλου δεδομένων›