profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsТипове компонентиSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyСкриптове в конструктора на шаблониProject ScaffoldingМедийна библиотека

Без глава

Бърз стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Преглед на REST APIgetСвързване на уебсайт към CMS APIgetGET /routesgetGET /routegetGET /blocksgetВземане на блокове с CEL кешgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПревод на публикацияpatchPATCH /translationsgetПолучаване на използванетоpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Изброй резюметата на персонализираните компоненти (схеми за тип съдържание) на уебсайт.

Изброй резюмета на custom-component (схеми за тип съдържание) за уебсайт, подредени по име. Връщат се само персонализирани схеми, дефинирани от потребителя.

Удостоверяване: API ключ (x-api-key заглавка или параметър на заявката api_key).

Параметри на заявката

ПараметърТипЗадължителенБележки
websiteIduuidдаТрябва да е валиден UUID. Няма резервен Host/конфигурационен вариант за тази крайна точка.
statestringнеФилтрира по състояние от жизнения цикъл: draft, active или archived.
api_keystringнеАлтернатива на заглавката x-api-key.

Отговор

JSON масив с резюмета на компоненти:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Публикация",
    "description": "Документационна публикация",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source винаги е "custom". displayName използва name като резервна стойност, а category по подразбиране е "Custom", когато не е зададена.

Пример

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

Грешки

  • 400 — липсващ или невалиден websiteId
  • 401 — невалиден API ключ
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›