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 proxySkriptovanie v nástroji na tvorbu šablónProject ScaffoldingKnižnica médií

Headless

Rýchly štartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Prehľad REST APIgetConnect your websitegetZískanie trásgetZískanie trasygetZískaj blokygetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Načítajte úplnú definíciu polí jedného vlastného komponentu podľa názvu.

Načítajte úplnú definíciu jedného vlastného komponentu podľa názvu vrátane jeho zoznamu polí.

Autorizácia: Kľúč API (hlavička x-api-key alebo dotazovací parameter api_key).

Parametre cesty

ParameterTypPovinnéPoznámky
namestringánoNázov schémy, napr. post.

Parametre dotazu

ParameterTypPovinnéPoznámky
websiteIduuidánoMusí byť platný identifikátor UUID.
api_keystringnieAlternatíva k hlavičke x-api-key.

Odpoveď

{
  "id": "...",
  "name": "post",
  "displayName": "Príspevok",
  "description": "Dokumentačný príspevok",
  "category": "Vlastné",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields sa počíta – názvy všetkých polí typu string.

Príklad

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

Chyby

  • 400 — chýbajúce alebo neplatné websiteId
  • 401 — neplatný kľúč API
  • 404 — schéma sa nenašla
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›