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/{name}

Gaukite vieno pasirinktinio komponento pilną laukų apibrėžimą pagal pavadinimą.

Gaukite vieno pasirinktinio komponento visą apibrėžtį pagal pavadinimą, įskaitant jo laukų sąrašą.

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

Kelio parametrai

ParametrasTipasPrivalomasPastabos
namestringtaipSchemos pavadinimas, pvz., post.

Užklausos parametrai

ParametrasTipasPrivalomasPastabos
websiteIduuidtaipTuri būti galiojantis UUID.
api_keystringneAlternatyva x-api-key antraštei.

Atsakymas

{
  "id": "...",
  "name": "post",
  "displayName": "Įrašas",
  "description": "Dokumentacijos įrašas",
  "category": "Pasirinktinis",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields apskaičiuojamas — visų teksto tipo laukų pavadinimai.

Pavyzdys

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

Klaidos

  • 400 — trūksta arba neteisingas websiteId
  • 401 — neteisingas API raktas
  • 404 — schema nerasta
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›