profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchYlläpitäjän hallintapaneelin välityspalvelimen määrittäminenCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

PikakäynnistysSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-ohjelmointirajapinta

REST API OverviewgetConnect 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}postPOST /translationpatchPATCH /translationsgetKäytön hakeminenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Listaa verkkosivuston mukautettujen komponenttien (sisältötyyppiskeeman) yhteenvedot.

Listaa verkkosivuston mukautettujen komponenttien (sisältötyyppiskeeman) yhteenvedot nimen mukaan lajiteltuna. Vain käyttäjän määrittämät mukautetut skeemat palautetaan.

Todennus: API-avain (x-api-key-otsake tai api_key-kyselyparametri).

Kyselyparametrit

ParametriTyyppiPakollinenHuomautukset
websiteIduuidkylläTäytyy olla kelvollinen UUID. Ei Host-/konfiguraatiovaravaihtoehtoa tällä päätepisteellä.
statestringeiSuodata elinkaaren tilan mukaan: draft, active tai archived.
api_keystringeiVaihtoehto x-api-key-otsakkeelle.

Vastaus

Komponenttien yhteenvetojen JSON-taulukko:

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

source on aina "custom". displayName palaa arvoon name, ja category oletusarvoon "Custom", kun arvoa ei ole asetettu.

Esimerkki

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

Virheet

  • 400 — puuttuva tai virheellinen websiteId
  • 401 — virheellinen API-avain
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›