profound-logoProfound CMS
⌘K
Admin
Theme
BelgelerTutorialBlogPhilosophy
BelgelerTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyŞablon oluşturucuda komut dosyası yazmaProject ScaffoldingMedia Library

Headless

Hızlı BaşlangıçSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetCEL önbelleği ile blokları getirgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getVeri kümesi şema adını algetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postGönderi çevirisipatchÇeviri yamalarıgetKullanımı alpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Özel bir bileşenin tam alan tanımını adına göre alın.

Alan listesini de içerecek şekilde, özel bir bileşenin tam tanımını adına göre alın.

Kimlik doğrulama: API anahtarı (x-api-key üstbilgisi veya api_key sorgu parametresi).

Yol parametreleri

ParametreTürGerekliNotlar
namestringevetŞema adı, örn. post.

Sorgu parametreleri

ParametreTürGerekliNotlar
websiteIduuidevetGeçerli bir UUID olmalıdır.
api_keystringhayırx-api-key üstbilgisine alternatif.

Yanıt

{
  "id": "...",
  "name": "post",
  "displayName": "Gönderi",
  "description": "Bir dokümantasyon Gönderisi",
  "category": "Özel",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields, tüm string tipindeki alanların adları olacak şekilde hesaplanır.

Örnek

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

Hatalar

  • 400 — eksik veya geçersiz websiteId
  • 401 — geçersiz API anahtarı
  • 404 — şema bulunamadı
Continue Reading
Previous‹GET /componentsNextVeri kümesi şema adını al›