profound-logoProfound CMS
⌘K
Admin
Theme
Tài liệuHướng dẫnBlogTriết học
Tài liệuHướng dẫnBlogTriết học

Kết hợp

Định tuyến tham sốCác loại ComponentSetup server sent events (SSE) content refetchThiết lập proxy bảng điều khiển quản trịCEL Scripting in Template BuilderProject ScaffoldingThư viện phương tiện

Không đầu

Bắt đầu nhanhJson và claude codeComponent Zod Pull

REST API

Tổng quan REST APIgetKết nối API trang webgetGET /routesgetLấy tuyếngetGET /blocksgetLấy các khối kèm bộ đệm CELgetGET /blocks/generatedgetGET /componentsgetLấy tên thành phầngetLấy tên lược đồ tập dữ liệugetGET /content-changes (SSE)patchCập nhật tên lược đồ tập dữ liệupostPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Lấy tên thành phần

Lấy định nghĩa đầy đủ của một thành phần tùy chỉnh theo tên.

Lấy đầy đủ định nghĩa của một thành phần tùy chỉnh duy nhất theo tên, bao gồm danh sách các trường của nó.

Xác thực: Khóa API (header x-api-key hoặc tham số truy vấn api_key).

Tham số đường dẫn

Tham sốKiểuBắt buộcGhi chú
namechuỗicóTên schema, ví dụ post.

Tham số truy vấn

Tham sốKiểuBắt buộcGhi chú
websiteIduuidcóPhải là một UUID hợp lệ.
api_keychuỗikhôngThay thế cho header x-api-key.

Phản hồi

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "Một bài viết tài liệu",
  "category": "Tùy chỉnh",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields được tính toán — tên của tất cả các trường kiểu chuỗi.

Ví dụ

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

Lỗi

  • 400 — thiếu hoặc websiteId không hợp lệ
  • 401 — khóa API không hợp lệ
  • 404 — không tìm thấy schema
Continue Reading
Previous‹GET /componentsNextLấy tên lược đồ tập dữ liệu›