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 proxyPisanje skripti u alatu za izradu predložakaProject ScaffoldingMedia Library

Bez sučelja

Brzi početakSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezivanje web-stranice s CMS API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrijevod objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Dohvati potpunu definiciju polja jedne prilagođene komponente prema nazivu.

Dohvati potpunu definiciju jedne prilagođene komponente prema nazivu, uključujući njezin popis polja.

Autorizacija: API ključ (zaglavlje x-api-key ili parametar upita api_key).

Parametri putanje

ParametarTipObaveznoNapomene
namestringdaNaziv sheme, npr. post.

Parametri upita

ParametarTipObaveznoNapomene
websiteIduuiddaMora biti valjani UUID.
api_keystringneAlternativa zaglavlju x-api-key.

Odgovor

{
  "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
}

Polje slugFields se računa — nazivi svih polja tipa string.

Primjer

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

Pogreške

  • 400 — nedostaje ili je nevažeći websiteId
  • 401 — nevažeći API ključ
  • 404 — shema nije pronađena
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›