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

Vypíše súhrny vlastných komponentov (schémy typu obsahu) webovej lokality.

Zobrazí súhrny vlastných komponentov (schémy typu obsahu) pre webovú lokalitu zoradené podľa názvu. Vrátia sa iba používateľom definované vlastné schémy.

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

Parametre dotazu

ParameterTypPovinnéPoznámky
websiteIduuidánoMusí byť platný UUID. Na tomto koncovom bode nie je dostupná žiadna záložná hodnota Host ani konfigurácia.
statestringnieFiltrovať podľa stavu životného cyklu: draft, active alebo archived.
api_keystringnieAlternatíva k hlavičke x-api-key.

Odpoveď

Pole JSON so súhrnmi komponentov:

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

source je vždy "custom". displayName sa preberá z name a category predvolene nadobúda hodnotu "Custom", ak nie je nastavená.

Príklad

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

Chyby

  • 400 — chýbajúce alebo neplatné websiteId
  • 401 — neplatný kľúč API
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›