profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrično usmerjanjeTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skript v graditelju predlogProject ScaffoldingMedijska knjižnica

Brez glave

Hitri začetekSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezava spletnega mesta z API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrevajanje objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Prikaže povzetke komponent po meri (shema vrste vsebine) za spletno mesto.

Prikaže povzetke komponent po meri (shema vrste vsebine) za spletno mesto, razvrščene po imenu. Vrnjene so samo sheme po meri, ki jih je določil uporabnik.

Avtentikacija: Ključ API (x-api-key glava ali parameter poizvedbe api_key).

Parametri poizvedbe

ParameterVrstaObveznoOpombe
websiteIduuiddaMora biti veljaven UUID. Na tej končni točki ni povratne možnosti za Host/konfiguracijo.
statestringneFiltriraj po življenjskem stanju: draft, active ali archived.
api_keystringneAlternativa glavi x-api-key.

Odgovor

Polje JSON s povzetki komponent:

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

source je vedno "custom". displayName se privzeto nastavi na name, category pa na "Custom", če ni določena.

Primer

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

Napake

  • 400 — manjkajoč ali neveljaven websiteId
  • 401 — neveljaven ključ API
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›