profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /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}

Recupera la definizione completa dei campi di un singolo componente personalizzato per nome.

Recupera la definizione completa di un singolo componente personalizzato per nome, inclusa la sua lista di campi.

Autenticazione: Chiave API (intestazione x-api-key o parametro di query api_key).

Parametri di percorso

ParametroTipoObbligatorioNote
namestringsìIl nome dello schema, ad es. post.

Parametri di query

ParametroTipoObbligatorioNote
websiteIduuidsìDeve essere un UUID valido.
api_keystringnoAlternativa all'intestazione x-api-key.

Risposta

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "Un post di documentazione",
  "category": "Personalizzato",
  "titleField": "titolo",
  "routeSlugField": "titolo",
  "icon": null,
  "fields": [
    { "name": "titolo", "type": "stringa", "required": true }
  ],
  "slugFields": ["titolo", "descrizione"],
  "version": 8
}

slugFields è calcolato — i nomi di tutti i campi di tipo stringa.

Esempio

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

Errori

  • 400 — websiteId mancante o non valido
  • 401 — chiave API non valida
  • 404 — schema non trovato
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›