profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametriskā maršrutēšanaKomponentu veidiSetup server sent events (SSE) content refetchIestatīt administratora paneļa starpniekserveriSkriptēšana veidņu veidotājāProject ScaffoldingMultivides bibliotēka

Headless

Ātrā uzsākšanaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetSaņemt maršrutusgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPēctulkošanapatchTulkojumu labojumigetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Uzskaita vietnes pielāgoto komponentu (satura tipa shēmu) kopsavilkumus.

Uzskaitīt vietnes pielāgoto komponentu (satura tipa shēmu) kopsavilkumus, sakārtotus pēc nosaukuma. Tiek atgrieztas tikai lietotāja definētās pielāgotās shēmas.

Autentifikācija: API atslēga (x-api-key galvene vai api_key vaicājuma parametrs).

Vaicājuma parametri

ParametrsTipsObligātsPiezīmes
websiteIduuidyesJābūt derīgam UUID. Šim galapunktam nav Host/konfigurācijas rezerves varianta.
statestringnoFiltrēt pēc dzīves cikla stāvokļa: draft, active vai archived.
api_keystringnoAlternatīva x-api-key galvenei.

Atbilde

JSON masīvs ar komponentu kopsavilkumiem:

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

source vienmēr ir "custom". Ja nav norādīts, displayName pieņem name vērtību, bet category pēc noklusējuma ir "Custom".

Piemērs

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

Kļūdas

  • 400 — trūkst vai nederīgs websiteId
  • 401 — nederīga API atslēga
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›