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

GET /components

Liệt kê các bản tóm tắt thành phần tùy chỉnh (schema loại nội dung) của một website.

Liệt kê các bản tóm tắt custom-component (schema loại nội dung) cho một website, được sắp xếp theo tên. Chỉ các schema tùy chỉnh do người dùng định nghĩa mới được trả về.

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

Tham số truy vấn

Tham sốKiểuBắt buộcGhi chú
websiteIduuidcóPhải là một UUID hợp lệ. Không có dự phòng Host/cấu hình cho endpoint này.
statestringkhôngLọc theo trạng thái vòng đời: draft, active hoặc archived.
api_keystringkhôngThay thế cho header x-api-key.

Phản hồi

Một mảng JSON gồm các bản tóm tắt thành phần:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source luôn là "custom". displayName sẽ sử dụng giá trị dự phòng là name, và category mặc định là "Custom" khi không được thiết lập.

Ví dụ

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

Lỗi

  • 400 — thiếu hoặc websiteId không hợp lệ
  • 401 — API key không hợp lệ
Continue Reading
Previous‹GET /blocks/generatedNextLấy tên thành phần›