Công cụ API Explorer được phát triển như một sandbox lập trình tương tác tích hợp ngay trong trang quản trị của PolyCMS. Giải pháp này cho phép các nhà phát triển thử nghiệm đầy đủ các phương thức HTTP (GET, POST, PUT, DELETE) với cơ sở dữ liệu thực tế mà không cần cài đặt các ứng dụng bên ngoài như Postman, hỗ trợ tối đa quá trình phát triển và tích hợp hệ thống.
Giới thiệu về API Explorer
API Explorer là một công cụ hỗ trợ lập trình viên được tích hợp sẵn, cung cấp môi trường thử nghiệm (sandbox) tương tác để kiểm tra tất cả các endpoint REST API của PolyCMS trực tiếp từ trang quản trị. Bạn không cần sử dụng các phần mềm bên ngoài như Postman hay Insomnia - mọi thao tác kiểm tra dữ liệu thực tế đều có thể thực hiện nhanh chóng ngay trong hệ thống CRM của bạn.
Bạn có thể thử nghiệm trực tiếp công cụ này tại trang demo chính thức của hệ thống: polycms.polyxgo.com/admin/polycms/api_explorer.
Cách thức truy cập và sử dụng
- Đăng nhập vào trang quản trị Perfex CRM, đi tới Blog > API Explorer.
- Đảm bảo rằng REST API đã được kích hoạt trong mục Blog > Cài đặt > REST API.
- Lựa chọn đối tượng dữ liệu cần kiểm tra trên các tab chức năng.
- Chọn phương thức HTTP tương ứng.
- Nhấp vào Gửi (Send) để thực thi yêu cầu và nhận kết quả phản hồi thời gian thực.
Các tính năng nổi bật của hệ thống
1. Thử nghiệm CRUD trực quan
Thực hiện các cuộc gọi API thực tế tới cơ sở dữ liệu của bạn chỉ với một cú nhấp chuột. Hệ thống tự động tạo cấu trúc request body với các giá trị mẫu kèm mốc thời gian để lập trình viên dễ dàng nhận diện và kiểm thử mà không cần viết mã JSON thủ công.
2. Cung cấp mã mẫu đa ngôn ngữ
Hệ thống tự động sinh mã nguồn mẫu tương ứng cho các ngôn ngữ và thư viện phổ biến: cURL, PHP, JavaScript (Fetch API), và Python (requests). Bạn có thể sao chép trực tiếp các đoạn mã này vào dự án của mình. Các đoạn mã đều đã được cấu hình sẵn địa chỉ endpoint và khóa xác thực API của website.
3. Bảng dữ liệu trực quan
Kết quả phản hồi của API được hiển thị dưới dạng bảng dữ liệu sạch sẽ, hỗ trợ:
- Huy hiệu trạng thái bài viết (Xuất bản, Nháp) trực quan.
- Đường liên kết xem trước giao diện người dùng.
- Cửa sổ xem chi tiết (modals) để kiểm tra toàn bộ cấu trúc bản ghi JSON.
4. Cơ chế kiểm thử thông minh (Smart PUT)
Khi kiểm tra các thao tác cập nhật dữ liệu (PUT), Explorer sẽ tự động đọc tiêu đề hiện tại của bản ghi và thêm mốc thời gian vào sau. Điều này giúp ngăn ngừa trùng lặp tiêu đề bài viết và giúp nhà phát triển dễ dàng nhận biết kết quả thay đổi khi thử nghiệm trên dữ liệu thực tế.
5. Tự động tải lại dữ liệu (Auto-Reload)
Sau khi thực hiện thành công các thao tác POST, PUT hoặc DELETE, danh sách dữ liệu hiển thị sẽ tự động làm mới để cập nhật trạng thái mới nhất từ cơ sở dữ liệu mà không cần tải lại trang web thủ công.
Bảo mật và tích hợp hệ thống
API Explorer sử dụng chính khóa API được cấu hình trên website của bạn. Mọi yêu cầu chạy qua Explorer đều phải đi qua hệ thống kiểm soát bảo mật và giới hạn tần suất yêu cầu (rate-limiting) giống hệt các kết nối từ bên ngoài. Điều này đảm bảo kết quả kiểm thử luôn phản ánh chính xác hành vi thực tế của hệ thống khi chạy trên môi trường production.