profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySzkriptelés a sablonkészítőbenProject ScaffoldingMédiatár

Fej nélküli

Quick startJSON és Claude kódComponent Zod Pull

REST API

REST API áttekintésgetConnect your websitegetGET /routesgetÚtvonal feloldásagetBlokkok lekérésegetGET /blocks/with-cel-cachegetGenerált blokkok lekérésegetKomponensek lekérésegetGET /components/{name}getAdatkészlet-séma nevének lekérésegetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postUtólagos fordításpatchFordítások javításagetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Komponensek lekérése

Egy webhely egyéni komponenseinek (tartalomtípus-sémáinak) összefoglalóit sorolja fel.

Kilistázza egy webhely egyéni komponenseinek (tartalomtípus-sémáinak) összefoglalóit név szerinti sorrendben. Csak a felhasználó által meghatározott egyéni sémák kerülnek visszaadásra.

Hitelesítés: API-kulcs (x-api-key fejléc vagy api_key lekérdezési paraméter).

Lekérdezési paraméterek

ParaméterTípusKötelezőMegjegyzés
websiteIduuidigenÉrvényes UUID-nek kell lennie. Ennél a végpontnál nincs Host/konfigurációs tartalék.
statestringnemSzűrés életciklus-állapot szerint: draft, active vagy archived.
api_keystringnemAz x-api-key fejléc alternatívája.

Válasz

A komponens-összefoglalók JSON tömbje:

[
  {
    "id": "...",
    "name": "bejegyzes",
    "displayName": "Bejegyzés",
    "description": "Egy dokumentációs bejegyzés",
    "category": "Egyéni",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "egyedi",
    "version": 8,
    "routeSlugField": "cim"
  }
]

source értéke mindig "egyedi". Ha nincs megadva, a displayName a name értékét veszi át, a category pedig alapértelmezetten "Egyéni".

Példa

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

Hibák

  • 400 — hiányzó vagy érvénytelen websiteId
  • 401 — érvénytelen API-kulcs
Continue Reading
Previous‹Generált blokkok lekéréseNextGET /components/{name}›