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/{name}

Získá úplnou definici polí jednoho vlastního komponentu podle názvu.

Načte úplnou definici jednoho vlastního komponentu podle názvu, včetně seznamu jeho polí.

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

Parametry cesty

ParametrTypPovinnéPoznámky
namestringanoNázev schématu, např. post.

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidanoMusí být platné UUID.
api_keystringneAlternativa k hlavičce x-api-key.

Odpověď

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields se počítá — názvy všech polí typu string.

Příklad

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

Chyby

  • 400 — chybějící nebo neplatné websiteId
  • 401 — neplatný klíč API
  • 404 — schéma nenalezeno
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›