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

Pridobi celotno definicijo polj ene prilagojene komponente po imenu.

Pridobi celotno definicijo ene prilagojene komponente po imenu, vključno z njenim seznamom polj.

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

Parametri poti

ParameterVrstaZahtevanoOpombe
namenizdaIme sheme, npr. post.

Parametri poizvedbe

ParameterVrstaZahtevanoOpombe
websiteIduuiddaMora biti veljaven UUID.
api_keynizneAlternativa glavi x-api-key.

Odgovor

{
  "id": "...",
  "name": "objava",
  "displayName": "Objava",
  "description": "Dokumentacijska objava",
  "category": "Po meri",
  "titleField": "naslov",
  "routeSlugField": "naslov",
  "icon": null,
  "fields": [
    { "name": "naslov", "type": "niz", "required": true }
  ],
  "slugFields": ["naslov", "opis"],
  "version": 8
}

slugFields je izračunan — imena vseh polj tipa niz.

Primer

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

Napake

  • 400 — manjkajoč ali neveljaven websiteId
  • 401 — neveljaven ključ API
  • 404 — shema ni najdena
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›