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

Wyświetl listę podsumowań niestandardowych komponentów (schemat typu treści) witryny.

Wyświetla listę streszczeń komponentów niestandardowych (schemat typu treści) dla witryny, uporządkowanych według nazwy. Zwracane są wyłącznie niestandardowe schematy zdefiniowane przez użytkownika.

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

Parametry zapytania

ParametrTypWymaganeUwagi
websiteIduuidtakMusi być prawidłowym identyfikatorem UUID. Brak mechanizmu zastępczego Host/konfiguracji dla tego punktu końcowego.
statestringnieFiltruj według stanu cyklu życia: draft, active lub archived.
api_keystringnieAlternatywa dla nagłówka x-api-key.

Odpowiedź

Tablica JSON z podsumowaniami komponentów:

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

source jest zawsze "custom". displayName domyślnie przyjmuje wartość name, a category domyślnie przyjmuje "Custom", jeśli nie zostały ustawione.

Przykład

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

Błędy

  • 400 — brakujący lub nieprawidłowy websiteId
  • 401 — nieprawidłowy klucz API
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›