profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrinis maršrutizavimasKomponentų tipaiSetup server sent events (SSE) content refetchAdministratoriaus skydelio tarpinio serverio nustatymasSkriptų kūrimas šablonų kūrimo priemonėjeProject ScaffoldingMedia Library

Be sąsajos

Greitasis startasSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API apžvalgagetPrijunkite svetainę prie CMS APIgetGET /routesgetGauti maršrutągetGET /blocksgetGET /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

Išvardykite svetainės pasirinktinių komponentų (turinio tipo schemų) santraukas.

Išvardykite tinklalapio pasirinktinių komponentų (turinio tipo schemų) santraukas, surikiuotas pagal pavadinimą. Grąžinamos tik naudotojo apibrėžtos pasirinktinės schemos.

Autentifikavimas: API raktas (x-api-key antraštė arba api_key užklausos parametras).

Užklausos parametrai

ParametrasTipasPrivalomaPastabos
websiteIduuidtaipPrivalo būti galiojantis UUID. Šiame galiniame taške nėra Host/konfigūracijos atsarginio varianto.
statestringneFiltruoti pagal gyvavimo ciklo būseną: draft, active arba archived.
api_keystringneAlternatyva x-api-key antraštei.

Atsakymas

JSON masyvas su komponentų santraukomis:

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

source visada yra "custom". displayName, jei nenustatytas, perima name, o category pagal numatymą yra "Custom".

Pavyzdys

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

Klaidos

  • 400 — trūksta arba neteisingas websiteId
  • 401 — neteisingas API raktas
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›