Một hợp đồng cho mọi thiết bị. 38 thao tác thuộc năm nhóm chức năng, có sẵn dưới dạng lệnh gọi REST đồng bộ và webhook Callback thời gian thực.
Mọi lệnh gọi REST đều gửi đến một máy chủ duy nhất có đánh phiên bản.
https://api.camsbiometrics.com/v3/
Mỗi yêu cầu đều mang theo một AuthToken có phạm vi theo tài khoản và thiết bị của bạn. Khóa được cấp từ cổng nhà phát triển.
Yêu cầu dạng form-encoded hoặc JSON. Phản hồi là JSON với các trường và mã lỗi dễ đoán.
Hai cách tích hợp
Bạn gọi gateway và nhận câu trả lời ngay lập tức. Hoàn hảo để lấy dữ liệu chấm công, liệt kê người dùng, đăng ký ai đó hoặc mở cửa theo yêu cầu.
Đăng ký một URL và gateway sẽ đẩy sự kiện đến bạn ngay khi thiết bị báo cáo — không cần polling, tự động thử lại khi lỗi.
Thao tác
Được nhóm theo chức năng. Tên ánh xạ 1:1 với các endpoint gateway bên dưới.
Tất cả lượt chấm công trong một khoảng ngày trên toàn tài khoản.
Log của một mã nhân viên trong một khoảng thời gian.
Các lượt chấm công được ghi nhận bởi một thiết bị theo số sê-ri.
Tổng hợp theo ngày, theo nhân viên (vào/ra, số giờ).
Cặp giờ vào đầu / ra cuối của mỗi nhân viên mỗi ngày.
Ảnh chụp nhanh trực tiếp các lượt chấm công hôm nay.
Ảnh chụp đính kèm lượt chấm công, nếu thiết bị hỗ trợ.
Xuất hàng loạt cho bảng lương & đối soát.
Tạo người dùng trên một hoặc nhiều thiết bị.
Chỉnh sửa tên, vai trò, thời hạn hiệu lực hoặc đặc quyền.
Xóa người dùng khỏi thiết bị.
Tra cứu người dùng theo mã, kèm thông tin xác thực tùy chọn.
Liệt kê tất cả người đã đăng ký trên một thiết bị.
Cho biết người dùng có mặt trên những thiết bị nào.
Đẩy mẫu vân tay đến thiết bị.
Đăng ký mẫu khuôn mặt nếu thiết bị hỗ trợ.
Gán thẻ RFID / thẻ tiệm cận cho người dùng.
Đặt hoặc đổi mã PIN / mật khẩu trên thiết bị.
Sao chép người dùng & mẫu sinh trắc học giữa các thiết bị.
Gửi lại dữ liệu người dùng vào hàng đợi của thiết bị.
Kích hoạt rơ-le cửa, cổng xoay, cổng flap, cổng swing hoặc thanh chắn boom theo thời gian thực.
Khóa / giữ cửa theo sự điều khiển của bạn.
Đọc trạng thái mở / đóng hiện tại.
Định nghĩa các khung giờ truy cập theo thời gian.
Log sự kiện vào / ra và cửa.
Danh sách kiểm kê mọi thiết bị đã kết nối.
Model, firmware, dung lượng và bộ đếm.
Trạng thái trực tuyến, lần cuối hoạt động và độ sâu hàng đợi.
Xác nhận ngay khả năng kết nối tới thiết bị.
Đồng bộ đồng hồ thiết bị với máy chủ.
Khởi động lại thiết bị từ xa.
Xóa các lệnh bị kẹt khỏi hàng đợi.
Theo dõi trạng thái của một lệnh trong hàng đợi.
Đăng ký một webhook URL để nhận sự kiện trực tiếp.
Được kích hoạt ở mỗi lượt chấm công, theo thời gian thực.
Chuyển đổi trạng thái trực tuyến / ngoại tuyến & tình trạng hoạt động.
Xác nhận khi một mẫu sinh trắc học đã được lưu vào thiết bị.
Theo dõi tiến độ di chuyển hàng loạt thiết bị / dữ liệu.
Phản hồi dễ đoán
| Mã | Ý nghĩa | Cần làm gì |
|---|---|---|
200 | Thành công | Xử lý payload JSON. |
401 | AuthToken không hợp lệ hoặc bị thiếu | Kiểm tra khóa API và việc ghép nối thiết bị. |
404 | Không tìm thấy thiết bị hoặc người dùng | Kiểm tra số sê-ri / mã nhân viên. |
409 | Thiết bị ngoại tuyến / đã xếp hàng đợi | Lệnh đã được xếp hàng đợi; hãy poll GetCommandStatus. |
429 | Bị giới hạn tốc độ | Giảm tốc độ và thử lại với jitter. |
Hướng dẫn bắt đầu nhanh đưa bạn từ khóa API đến log chấm công đầu tiên chỉ trong vài phút.
Chúng tôi dùng cookie để đo lường lưu lượng truy cập và cải thiện BiometricAPI.com. Công cụ phân tích sẽ tắt cho đến khi bạn đồng ý. Tìm hiểu thêm.