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

Prikažite sažetke prilagođenih komponenti (shema vrste sadržaja) za web-mjesto.

Prikažite sažetke prilagođenih komponenti (shema vrste sadržaja) za web-mjesto, poredane prema nazivu. Vraćaju se samo prilagođene sheme koje je definirao korisnik.

Autentifikacija: API ključ (zaglavlje x-api-key ili upitni parametar api_key).

Upitni parametri

ParametarTipObaveznoNapomene
websiteIduuiddaMora biti valjani UUID. Na ovoj krajnjoj točki nema rezervnog Host/konfiguracijskog parametra.
statestringneFiltrira prema stanju životnog ciklusa: draft, active ili archived.
api_keystringneAlternativa zaglavlju x-api-key.

Odgovor

JSON niz sažetaka komponenti:

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

source je uvijek "custom". displayName se vraća na name, a category zadano je "Custom" kada nije postavljeno.

Primjer

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

Pogreške

  • 400 — websiteId nedostaje ili je nevažeći
  • 401 — nevažeći API ključ
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›