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 proxyCEL Scripting in Template BuilderProject ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /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}

Preia definiția completă a câmpurilor unei componente personalizate după nume.

Preia definiția completă a unei componente personalizate unice după nume, inclusiv lista câmpurilor sale.

Autentificare: Cheie API (antet x-api-key sau parametru de interogare api_key).

Parametri de rută

ParametruTipObligatoriuNote
namestringdaNumele schemei, de ex. post.

Parametri de interogare

ParametruTipObligatoriuNote
websiteIduuiddaTrebuie să fie un UUID valid.
api_keystringnuAlternativă la antetul x-api-key.

Răspuns

{
  "id": "...",
  "name": "postare",
  "displayName": "Postare",
  "description": "O postare de documentație",
  "category": "Personalizat",
  "titleField": "titlu",
  "routeSlugField": "titlu",
  "icon": null,
  "fields": [
    { "name": "titlu", "type": "string", "required": true }
  ],
  "slugFields": ["titlu", "descriere"],
  "version": 8
}

slugFields este calculat — numele tuturor câmpurilor de tip string.

Exemplu

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

Erori

  • 400 — websiteId lipsă sau invalid
  • 401 — cheie API invalidă
  • 404 — schemă negăsită
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›