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 proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /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}

Récupérez la définition complète des champs d'un composant personnalisé unique par son nom.

Récupérez la définition complète d'un composant personnalisé unique par son nom, y compris la liste de ses champs.

Auth : Clé d'API (en-tête x-api-key ou paramètre de requête api_key).

Paramètres de chemin

ParamètreTypeObligatoireRemarques
namestringouiLe nom du schéma, p. ex. post.

Paramètres de requête

ParamètreTypeObligatoireRemarques
websiteIduuidouiDoit être un UUID valide.
api_keystringnonAlternative à l'en-tête x-api-key.

Réponse

{
  "id": "...",
  "name": "post",
  "displayName": "Article",
  "description": "Un article de documentation",
  "category": "Personnalisé",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields est calculé : il s'agit des noms de tous les champs de type chaîne.

Exemple

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

Erreurs

  • 400 — websiteId manquant ou invalide
  • 401 — clé d'API invalide
  • 404 — schéma introuvable
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›