Kiểm thử API cục bộ
Cách nhận callback của thiết bị trên máy phát triển và kiểm thử lệnh REST bằng Postman trước khi triển khai.
Kiểm thử cục bộ (không cần triển khai lên máy chủ)
Để kiểm thử tích hợp callback từ máy phát triển cục bộ — mà không cần triển khai lên máy chủ production — bạn cần làm cho máy của mình truy cập được từ internet để Cams Protocol Engine có thể POST dữ liệu callback đến.
Phương án A: IP công khai + chuyển tiếp cổng
Nếu kết nối internet của bạn có địa chỉ IP công khai (tĩnh), bạn có thể chuyển tiếp một cổng bên ngoài đến ứng dụng cục bộ của mình.
Tìm IP công khai của bạn
Truy cập whatismyip.com hoặc chạy curl ifconfig.me trong terminal. Ghi lại địa chỉ IP công khai của bạn.
Thiết lập chuyển tiếp cổng trên router
Đăng nhập trang quản trị router. Chuyển tiếp một cổng bên ngoài (ví dụ 8080) đến IP nội bộ của máy bạn và cổng mà ứng dụng đang chạy (ví dụ 3000, 5000, 8080).
Cấu hình Callback URL
Trong API Monitor, đặt Callback URL của bạn thành:http://YOUR_PUBLIC_IP:8080/callback
Kiểm thử
Tạo một lượt chấm công trên thiết bị sinh trắc học. Cams Protocol Engine sẽ POST dữ liệu callback đến IP công khai của bạn, và router chuyển tiếp đến ứng dụng cục bộ.
Phương án B: Công cụ tunnel (không cần IP công khai)
Nếu bạn không có IP công khai hoặc không thể cấu hình chuyển tiếp cổng, hãy dùng dịch vụ tunnel để đưa máy chủ cục bộ ra internet.
| Công cụ | Lệnh | Ghi chú |
|---|---|---|
| ngrok | ngrok http 3000 | Có gói miễn phí. Cấp ngay một URL HTTPS công khai. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Miễn phí. Không cần tài khoản cho quick tunnel. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Không cần cài đặt. Hoạt động qua SSH. |
Khởi động ứng dụng cục bộ của bạn
Chạy máy chủ callback cục bộ (ví dụ php -S localhost:8080 hoặc node server.js hoặc python app.py).
Khởi động tunnel
Chạy công cụ tunnel. Công cụ sẽ xuất ra một URL công khai như https://abc123.ngrok-free.app.
Cấu hình Callback URL
Trong API Monitor, đặt Callback URL thành URL tunnel:https://abc123.ngrok-free.app/callback
Kiểm thử
Tạo một lượt chấm công. Callback sẽ đi qua tunnel đến máy cục bộ của bạn theo thời gian thực.
Kiểm thử URL
Trước khi đưa vào hoạt động, hãy xác minh các endpoint của bạn bằng Postman. Chúng tôi cung cấp sẵn một collection với đầy đủ 27 thao tác RESTful đã được cấu hình.
Postman Collection
Tải về và nhập vào Postman. Đặt các biến base_url, stgid và auth_token — rồi bắt đầu kiểm thử ngay.
Nhập collection
Mở Postman → Import → kéo và thả tệp .json đã tải về. Cả 27 thao tác RESTful được nhóm theo danh mục.
Đặt các biến
Vào tab Variables của collection và đặt:
base_url = URL endpoint RESTful của bạn (từ API Monitor)
stgid = Service Tag ID của thiết bị
auth_token = AuthToken của thiết bị
Gửi yêu cầu
Chọn một thao tác bất kỳ, chỉnh body JSON theo giá trị của bạn và nhấn Send. Kiểm tra phản hồi khớp với định dạng mong đợi đã nêu ở trên.
Ví dụ trên Postman
Ảnh chụp màn hình bên dưới cho thấy một yêu cầu API mẫu được cấu hình trong Postman. Đặt phương thức là POST, dán URL endpoint RESTful của bạn kèm ?stgid=, và dùng body raw JSON.
{"status":"done"} với HTTP 200.