profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySzkriptelés a sablonkészítőbenProject ScaffoldingMédiatár

Fej nélküli

Quick startJSON és Claude kódComponent Zod Pull

REST API

REST API áttekintésgetConnect your websitegetGET /routesgetÚtvonal feloldásagetBlokkok lekérésegetGET /blocks/with-cel-cachegetGenerált blokkok lekérésegetKomponensek lekérésegetGET /components/{name}getAdatkészlet-séma nevének lekérésegetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postUtólagos fordításpatchFordítások javításagetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Lekér egy egyedi komponens teljes meződefinícióját név alapján.

Lekér egy egyedi komponens teljes definícióját név alapján, beleértve a mezőlistáját.

Hitelesítés: API-kulcs (x-api-key fejléc vagy api_key lekérdezési paraméter).

Útvonalparaméterek

ParaméterTípusKötelezőMegjegyzések
namestringigenA séma neve, pl. post.

Lekérdezési paraméterek

ParaméterTípusKötelezőMegjegyzések
websiteIduuidigenÉrvényes UUID-nek kell lennie.
api_keystringnemAz x-api-key fejléc alternatívája.

Válasz

{
  "id": "...",
  "name": "post",
  "displayName": "Bejegyzés",
  "description": "Egy dokumentációs bejegyzés",
  "category": "Egyedi",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

A slugFields értéke számított — az összes karakterlánc típusú mező neve.

Példa

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

Hibák

  • 400 — hiányzó vagy érvénytelen websiteId
  • 401 — érvénytelen API-kulcs
  • 404 — a séma nem található
Continue Reading
Previous‹Komponensek lekéréseNextAdatkészlet-séma nevének lekérése›