profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypy komponentówSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySkrypty w kreatorze szablonówProject ScaffoldingBiblioteka multimediów

Headless

Szybki startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Przegląd REST APIgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postTłumaczenie postapatchKorekty tłumaczeńgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Pobierz pełną definicję pól pojedynczego niestandardowego komponentu według nazwy.

Pobierz pełną definicję pojedynczego niestandardowego komponentu według nazwy, łącznie z listą pól.

Uwierzytelnianie: Klucz API (nagłówek x-api-key lub parametr zapytania api_key).

Parametry ścieżki

ParametrTypWymaganeUwagi
namestringtakNazwa schematu, np. post.

Parametry zapytania

ParametrTypWymaganeUwagi
websiteIduuidtakMusi być prawidłowym identyfikatorem UUID.
api_keystringnieAlternatywa dla nagłówka x-api-key.

Odpowiedź

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

slugFields są obliczane — nazwy wszystkich pól typu string.

Przykład

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

Błędy

  • 400 — brak lub nieprawidłowe websiteId
  • 401 — nieprawidłowy klucz API
  • 404 — nie znaleziono schematu
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›