profound-logoProfound CMS
⌘K
Admin
Theme
DokumentaceTutorialBlogPhilosophy
DokumentaceTutorialBlogPhilosophy

Hybrid

Parametrické směrováníTypes of ComponentsSetup server sent events (SSE) content refetchNastavení proxy administračního paneluCEL Scripting in Template BuilderProject ScaffoldingKnihovna médií

Headless

Rychlý startJson a claude kódComponent Zod Pull

rozhraní REST API

REST API OverviewgetPřipojení webu k API CMSgetGET /routesgetGET /routegetGET /blocksgetzískat bloky s mezipamětí CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPřeklad po publikacipatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Vypsat souhrny vlastních komponent (schémat typu obsahu) webu.

Vypíše souhrny vlastních komponent (schémat typu obsahu) pro web, seřazené podle názvu. Vrácena jsou pouze vlastní schémata definovaná uživatelem.

Autorizace: Klíč API (hlavička x-api-key nebo query parametr api_key).

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidanoMusí být platné UUID. Na tomto koncovém bodu není k dispozici žádná záložní hodnota Host/konfigurace.
statestringneFiltr podle stavu životního cyklu: draft, active nebo archived.
api_keystringneAlternativa k hlavičce x-api-key.

Odpověď

Pole JSON se souhrny komponent:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

Hodnota source je vždy "custom". Pole displayName se při chybě vrací k name a category má ve výchozím nastavení hodnotu "Custom", pokud není nastaveno.

Příklad

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

Chyby

  • 400 — chybějící nebo neplatný websiteId
  • 401 — neplatný klíč API
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›