Màn hình API Explorer trong PolyCMS: Môi trường Sandbox thử nghiệm REST API

Last updated on Jul 10, 2026 2:11 AM

API Explorer là gì?

API Explorer là một công cụ tích hợp sẵn dành cho các nhà phát triển, cung cấp môi trường sandbox trực quan giúp kiểm thử toàn bộ các endpoint của PolyCMS REST API trực tiếp ngay trong trang quản trị của bạn. Không cần cài đặt các công cụ bên thứ ba như Postman — bạn có thể chạy thử nghiệm các phương thức GET, POST, PUT và DELETE trên dữ liệu thực tế ngay lòng CRM.

Trang chạy thử Demo: Bạn có thể trải nghiệm trực tiếp API Explorer tại địa chỉ trang demo chính thức: polycms.polyxgo.com/admin/polycms/api_explorer.

Các bước truy cập

Di chuyển đến mục Blog > API Explorer trên thanh bên quản lý của Perfex CRM.
Đảm bảo dịch vụ REST API đã được kích hoạt tại mục Blog > Settings > REST API (Xem thêm hướng dẫn thiết lập REST API).
Chọn phân hệ tài nguyên bạn cần kiểm thử ở các tab điều hướng.
Lựa chọn phương thức HTTP tương ứng.
Nhấn chọn Send để thực thi yêu cầu gọi API.

Danh sách các tài nguyên hỗ trợ

API Explorer hỗ trợ chạy thử nghiệm tương tác đầy đủ trên toàn bộ các tài nguyên của PolyCMS:

Tài nguyên dữ liệu	GET	POST	PUT	DELETE	Ghi chú giải thích
Bài viết (Posts)	✓	✓	✓	✓	Đầy đủ các thao tác CRUD trên dữ liệu thực
Trang tĩnh (Pages)	✓	✓	✓	✓	Đầy đủ các thao tác CRUD trên dữ liệu thực
Chuyên mục (Categories)	✓	✓	✓	✓	Hỗ trợ đầy đủ cấu trúc phân cấp đa cấp
Thẻ tag (Tags)	✓	✓	✓	✓	Đầy đủ các thao tác CRUD trên dữ liệu thực
Thư viện phương tiện (Media)	✓	✓	—	✓	Lưu trữ cơ sở dữ liệu, hỗ trợ phân trang

Các tính năng nổi bật

Chạy thử nghiệm CRUD trực tiếp

Thực thi các lệnh gọi API thực tế trên dữ liệu hệ thống chỉ bằng 1 cú nhấp chuột. Trình Explorer tự động sinh ra cấu trúc nội dung yêu cầu (request bodies) đi kèm dữ liệu mẫu và mốc thời gian để bạn dễ dàng theo dõi. Bạn hoàn toàn không cần phải tự tay soạn thảo mã JSON.Hỗ trợ đa dạng mẫu Code mẫu (Code Samples)

Dễ dàng chuyển đổi mẫu code gọi API giữa các ngôn ngữ cURL, PHP, JavaScript (Fetch API) và Python (requests) trực tiếp trên giao diện tab. Bạn có thể sao chép nhanh các đoạn code này để nhúng trực tiếp vào dự án của mình. Các đoạn code đều được tự động điền sẵn địa chỉ API của trang web cùng mã API key tương ứng.

# Ví dụ: Đoạn mã cURL sinh ra từ API Explorer
curl -X GET \
  -H "X-PolyCMS-API-Key: pcms_your_key_here" \
  -H "Accept: application/json" \
  "https://your-site.com/cms/api/v1/posts"

Bảng dữ liệu trực quan

Kết quả truy xuất được trình bày gọn gàng trên bảng dữ liệu hỗ trợ lọc và sắp xếp:

Hiển thị nhãn trạng thái bài viết (Published, Draft)
Các liên kết xem nhanh bài viết ngoài giao diện
Khung popup chi tiết để kiểm tra toàn bộ thông tin của bản ghi
Bố cục responsive hiển thị tối ưu trên nhiều màn hình

Hỗ trợ thông minh cho kiểm thử cập nhật (PUT Testing)

Khi bạn chạy thử nghiệm cập nhật dữ liệu, hệ thống tự động đọc tiêu đề hiện có và chèn thêm mốc thời gian — giúp tránh lỗi trùng lặp tiêu đề và giúp bạn dễ dàng nhận thấy sự thay đổi. Tính năng này giúp bạn kiểm thử an toàn các thao tác cập nhật dữ liệu mà không lo bị nhầm lẫn.

Tự động tải lại danh sách

Sau khi thực thi thành công các phương thức ghi dữ liệu POST, PUT hoặc DELETE, danh sách dữ liệu hiển thị sẽ tự động được tải lại để cập nhật trạng thái mới nhất mà bạn không cần phải reload lại trang quản trị.

Các thao tác trên Thư viện phương tiện (Media)

Tab Media trong màn hình API Explorer kết nối trực tiếp với cơ sở dữ liệu blog_media được cập nhật từ phiên bản v1.1.0:

Duyệt tìm tệp phương tiện

Xem toàn bộ danh sách tệp tin đã tải lên từ cơ sở dữ liệu blog_media hỗ trợ phân trang, tìm kiếm tên tệp và lọc theo định dạng MIME. Mỗi dòng bản ghi hiển thị chi tiết tên tệp, đường dẫn lưu trữ, kích thước ảnh, dung lượng file và định dạng tệp.

Tải lên tệp phương tiện (Upload)

Kiểm tra tính năng tải lên tệp tin thông qua biểu mẫu hỗ trợ multipart/form-data tích hợp sẵn. Dữ liệu phản hồi trả về sẽ cung cấp mã media_id mới để bạn sử dụng ngay làm ảnh đại diện feature_image_id cho bài viết hoặc trang tĩnh. Toàn bộ tiến trình tải lên đều đi qua hệ thống kiểm duyệt bảo mật 6 lớp.

Xóa tệp phương tiện (Delete)

Xóa bỏ tệp tin khỏi hệ thống đi kèm quy trình dọn dẹp dữ liệu chéo:

Xóa tệp tin vật lý cùng các ảnh thu nhỏ thumbnail tương ứng trên ổ đĩa.
Xóa dòng bản ghi tệp tin trong bảng cơ sở dữ liệu blog_media.
Tự động xóa gán ảnh đại diện feature_image và mã feature_image_id trên toàn bộ các bài viết hay trang tĩnh đang sử dụng tệp tin này.

Chính sách Bảo mật

API Explorer sử dụng API key được cấu hình trên chính hệ thống của bạn để chạy thử nghiệm. Mọi yêu cầu gọi đi đều tuân thủ chặt chẽ các **quy trình xác thực và giới hạn tần suất gọi** tương tự như các ứng dụng bên ngoài gọi đến.

Điều này đồng nghĩa với:

Áp dụng giới hạn rate limits (mặc định: 60 lượt đọc / 30 lượt ghi mỗi phút).
Kích hoạt toàn bộ các middleware bảo mật (bộ lọc HTMLPurifier, lọc mã độc đầu vào).
Dữ liệu phản hồi trả về hoàn toàn đồng bộ với những gì các ứng dụng bên ngoài nhận được.

Đối tượng sử dụng phù hợp

API Explorer được thiết kế tối ưu cho:

Nhà phát triển Plugins xây dựng các mô-đun mở rộng tương tác với dữ liệu CMS.
Nhà phát triển Giao diện (Themes) thiết kế các trang frontend không đầu (headless) sử dụng React, Vue, hay Next.js.
Kỹ sư tích hợp hệ thống kết nối dữ liệu PolyCMS với các ứng dụng di động, trang SPA hoặc các phần mềm quản trị bên thứ ba.
Đội ngũ kiểm thử QA xác thực tính chuẩn xác của API so với tài liệu kỹ thuật.

Tài liệu hướng dẫn liên quan

Tài liệu PolyCMS REST API — Mô tả chi tiết cơ chế xác thực, danh sách endpoints và chính sách bảo mật API.
Tự phát triển một Plugin tùy biến — Hướng dẫn cho nhà phát triển viết plugin tương tác với REST API.
Tài liệu tham khảo Hooks & Filters — Hướng dẫn đăng ký action và filter tùy biến.
Quản lý Plugins — Cách quản lý plugin API Explorer và các tiện ích đi kèm.
Hướng dẫn Thư viện phương tiện — Tìm hiểu sâu về cơ chế quản lý tệp tin phương tiện.