profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametriskā maršrutēšanaKomponentu veidiSetup server sent events (SSE) content refetchIestatīt administratora paneļa starpniekserveriSkriptēšana veidņu veidotājāProject ScaffoldingMultivides bibliotēka

Headless

Ātrā uzsākšanaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetSaņemt maršrutusgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPēctulkošanapatchTulkojumu labojumigetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Iegūstiet viena pielāgota komponenta pilnu lauku definīciju pēc nosaukuma.

Iegūstiet viena pielāgota komponenta pilnu definīciju pēc nosaukuma, ieskaitot tā lauku sarakstu.

Autentifikācija: API atslēga (x-api-key galvene vai api_key vaicājuma parametrs).

Ceļa parametri

ParametrsTipsObligātsPiezīmes
namevirknejāShēmas nosaukums, piem., post.

Vaicājuma parametri

ParametrsTipsObligātsPiezīmes
websiteIduuidjāJābūt derīgam UUID.
api_keyvirknenēAlternatīva x-api-key galvenei.

Atbilde

{
  "id": "...",
  "name": "post",
  "displayName": "Ieraksts",
  "description": "Dokumentācijas ieraksts",
  "category": "Pielāgots",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "virkne", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields tiek aprēķināti — visu virknes tipa lauku nosaukumi.

Piemērs

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

Kļūdas

  • 400 — trūkst vai ir nederīgs websiteId
  • 401 — nederīga API atslēga
  • 404 — shēma nav atrasta
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›