หน้าแรก / เอกสารอ้างอิง API

Biometric Gateway API

สัญญาเดียวสำหรับทุกอุปกรณ์ 38 การดำเนินการใน 5 กลุ่มความสามารถ ใช้ได้ทั้งการเรียก REST แบบซิงโครนัสและ webhook Callback แบบเรียลไทม์

🌐

Base URL

การเรียก REST ทั้งหมดส่งไปยังโฮสต์เดียวที่มีเวอร์ชันกำกับ

https://api.camsbiometrics.com/v3/

🔑

การยืนยันตัวตน

ทุกคำขอต้องแนบ AuthToken ที่จำกัดขอบเขตตามบัญชีและอุปกรณ์ของคุณ คีย์ออกให้จากพอร์ทัลนักพัฒนา

📦

รูปแบบ

คำขอแบบ form-encoded หรือ JSON การตอบกลับเป็น JSON พร้อมฟิลด์และรหัสข้อผิดพลาดที่คาดเดาได้

สองวิธีในการผสานรวม

REST เมื่อคุณถาม Callback เมื่อเหตุการณ์เกิดขึ้น

REST

คำขอ / การตอบกลับ

คุณเรียกเกตเวย์แล้วได้คำตอบทันที เหมาะสำหรับดึงข้อมูลการลงเวลา แสดงรายการผู้ใช้ ลงทะเบียนบุคคล หรือเปิดประตูตามต้องการ

  • ซิงโครนัสและคาดเดาได้
  • เหมาะกับการซิงก์ รายงาน และงานผู้ดูแลระบบ
  • ใช้ได้จากทุกภาษาหรือ cURL
CALLBACK

webhook แบบเรียลไทม์

ลงทะเบียน URL แล้วเกตเวย์จะพุชอีเวนต์มาให้ทันทีที่อุปกรณ์รายงาน — ไม่ต้องโพลล์ พร้อมการลองใหม่อัตโนมัติเมื่อล้มเหลว

  • อีเวนต์การลงเวลาและสถานะแบบทันที
  • ไม่ต้องใช้ cron job ไม่พลาดการลงเวลา
  • ลองใหม่จนกว่า endpoint ของคุณจะตอบรับ

การดำเนินการ

ครบทั้ง 38 การดำเนินการ

จัดกลุ่มตามหน้าที่ ชื่อสอดคล้อง 1:1 กับ endpoint ของเกตเวย์เบื้องหลัง

📊

การลงเวลา · 8

GET
GetAttendanceByDate

การลงเวลาทั้งหมดภายในช่วงวันที่ของทั้งบัญชี

GET
GetAttendanceByEmployee

ล็อกของรหัสพนักงานหนึ่งคนตลอดช่วงเวลาที่กำหนด

GET
GetAttendanceByDevice

การลงเวลาที่บันทึกโดยอุปกรณ์หนึ่งหมายเลขซีเรียล

GET
GetAttendanceSummary

สรุปรายวันรายพนักงาน (เข้า/ออก ชั่วโมง)

GET
GetFirstInLastOut

คู่เข้าแรก / ออกหลังสุดต่อพนักงานต่อวัน

GET
GetTodayAttendance

ภาพรวมสดของการลงเวลาในวันนี้

GET
GetAttendancePhoto

ภาพถ่ายที่แนบกับการลงเวลา สำหรับอุปกรณ์ที่รองรับ

GET
ExportAttendance

ส่งออกเป็นชุดสำหรับเงินเดือนและการกระทบยอด

👤

ผู้ใช้และการลงทะเบียน · 12

POST
AddUser

สร้างผู้ใช้บนอุปกรณ์หนึ่งเครื่องหรือมากกว่า

POST
UpdateUser

แก้ไขชื่อ บทบาท ระยะเวลาที่ใช้ได้ หรือสิทธิ์

POST
DeleteUser

ลบผู้ใช้ออกจากอุปกรณ์

GET
FindUser

ค้นหาผู้ใช้ด้วยรหัส พร้อมข้อมูลประจำตัวแบบเลือกได้

GET
ListUsers

แสดงรายการทุกคนที่ลงทะเบียนบนอุปกรณ์

GET
ListUserDevices

แสดงว่าผู้ใช้มีอยู่บนอุปกรณ์เครื่องใดบ้าง

POST
EnrollFingerprint

พุชเทมเพลตลายนิ้วมือไปยังอุปกรณ์

POST
EnrollFace

ลงทะเบียนเทมเพลตใบหน้า สำหรับอุปกรณ์ที่รองรับ

POST
EnrollCard

กำหนดบัตร RFID / บัตรใกล้ให้ผู้ใช้

POST
SetUserPassword

ตั้งหรือเปลี่ยน PIN / รหัสผ่านของอุปกรณ์

POST
CopyUsers

คัดลอกผู้ใช้และเทมเพลตระหว่างอุปกรณ์

POST
ResendUser

ส่งข้อมูลของผู้ใช้ไปยังคิวของอุปกรณ์อีกครั้ง

🔒

การควบคุมการเข้าถึง · 5

POST
OpenDoor

สั่งรีเลย์ประตู ประตูหมุน แฟลป สวิง หรือไม้กั้นบูมแบบเรียลไทม์

POST
LockDoor

ล็อก / ค้างประตูไว้ภายใต้การควบคุมของคุณ

GET
GetDoorStatus

อ่านสถานะเปิด / ปิดปัจจุบัน

POST
SetAccessSchedule

กำหนดช่วงเวลาการเข้าถึงตามเวลา

GET
GetAccessEvents

ล็อกอีเวนต์เข้า / ออกและประตู

📡

การจัดการอุปกรณ์ · 8

GET
ListDevices

รายการอุปกรณ์ที่เชื่อมต่อทั้งหมด

GET
GetDeviceInfo

รุ่น เฟิร์มแวร์ ความจุ และตัวนับ

GET
CheckDeviceHealth

สถานะออนไลน์ เวลาที่พบล่าสุด และความลึกของคิว

GET
PingConnection

ยืนยันว่าเข้าถึงอุปกรณ์ได้ในขณะนี้

POST
SyncDeviceTime

ปรับนาฬิกาของอุปกรณ์ให้ตรงกับเซิร์ฟเวอร์

POST
RebootDevice

รีสตาร์ทอุปกรณ์จากระยะไกล

POST
ResetDeviceQueue

ล้างคำสั่งที่ค้างออกจากคิว

GET
GetCommandStatus

ติดตามสถานะของคำสั่งที่อยู่ในคิว

🔌

เรียลไทม์ callback และระบบ · 5

POST
RegisterCallback

สมัครรับ webhook URL สำหรับอีเวนต์สด

PUSH
attendance.new

ทริกเกอร์ทุกครั้งที่มีการลงเวลา แบบเรียลไทม์

PUSH
device.status

การเปลี่ยนสถานะออนไลน์ / ออฟไลน์และสถานะการทำงาน

PUSH
enrollment.update

การยืนยันเมื่อเทมเพลตถูกส่งถึงอุปกรณ์

GET
MigrationStatus

ติดตามความคืบหน้าการย้ายอุปกรณ์ / ข้อมูลเป็นชุด

การตอบกลับที่คาดเดาได้

รหัสสถานะที่ใช้แยกเงื่อนไขได้

รหัสความหมายสิ่งที่ควรทำ
200สำเร็จประมวลผล JSON payload
401AuthToken ไม่ถูกต้องหรือไม่มีตรวจสอบ API key และการจับคู่อุปกรณ์
404ไม่พบอุปกรณ์หรือผู้ใช้ตรวจสอบหมายเลขซีเรียล / รหัสพนักงาน
409อุปกรณ์ออฟไลน์ / อยู่ในคิวคำสั่งอยู่ในคิว โพลล์ GetCommandStatus
429ถูกจำกัดอัตราถอยกลับแล้วลองใหม่โดยสุ่มหน่วงเวลา (jitter)

พร้อมเรียก endpoint แรกของคุณหรือยัง

คู่มือเริ่มต้นใช้งานด่วนพาคุณจาก API key ไปสู่ล็อกการลงเวลาแรกในเวลาไม่กี่นาที