Beranda / Referensi API

Biometric Gateway API

Satu kontrak untuk setiap perangkat. 38 operasi dalam lima kelompok kemampuan, tersedia sebagai panggilan REST sinkron dan webhook Callback real-time.

🌐

Base URL

Semua panggilan REST dilakukan ke satu host berversi.

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

🔑

Autentikasi

Setiap permintaan membawa AuthToken yang dibatasi pada akun dan perangkat Anda. Kunci diterbitkan dari portal pengembang.

📦

Format

Permintaan berformat form-encoded atau JSON. Respons berupa JSON dengan kolom dan kode error yang dapat diprediksi.

Dua cara untuk berintegrasi

REST saat Anda meminta. Callback saat sesuatu terjadi.

REST

Permintaan / respons

Anda memanggil gateway dan langsung mendapat jawaban. Sempurna untuk mengambil data absensi, mendaftar pengguna, mendaftarkan seseorang, atau membuka pintu sesuai permintaan.

  • Sinkron & dapat diprediksi
  • Cocok untuk sinkronisasi, laporan, dan tindakan admin
  • Berfungsi dari bahasa apa pun atau cURL
CALLBACK

Webhook real-time

Daftarkan sebuah URL dan gateway mengirimkan event kepada Anda seketika perangkat melaporkannya — tanpa polling, dengan percobaan ulang otomatis saat gagal.

  • Event absensi & status instan
  • Tanpa cron job, tanpa absen yang terlewat
  • Mencoba ulang hingga endpoint Anda mengonfirmasi

Operasi

Semua 38 operasi

Dikelompokkan berdasarkan fungsinya. Nama dipetakan 1:1 ke endpoint gateway yang mendasarinya.

📊

Absensi · 8

GET
GetAttendanceByDate

Semua absen dalam rentang tanggal di seluruh akun.

GET
GetAttendanceByEmployee

Log untuk satu kode karyawan dalam suatu periode.

GET
GetAttendanceByDevice

Absen yang direkam oleh satu nomor seri perangkat.

GET
GetAttendanceSummary

Ringkasan per hari, per karyawan (masuk/keluar, jam).

GET
GetFirstInLastOut

Pasangan masuk pertama / keluar terakhir per karyawan per hari.

GET
GetTodayAttendance

Cuplikan langsung absen hari ini.

GET
GetAttendancePhoto

Foto yang diambil bersama absen, jika didukung.

GET
ExportAttendance

Ekspor massal untuk penggajian & rekonsiliasi.

👤

Pengguna & pendaftaran · 12

POST
AddUser

Buat pengguna di satu perangkat atau lebih.

POST
UpdateUser

Ubah nama, peran, masa berlaku, atau hak akses.

POST
DeleteUser

Hapus pengguna dari perangkat.

GET
FindUser

Cari pengguna berdasarkan kode, dengan kredensial opsional.

GET
ListUsers

Daftar semua orang yang terdaftar di sebuah perangkat.

GET
ListUserDevices

Tampilkan perangkat mana saja tempat pengguna terdaftar.

POST
EnrollFingerprint

Kirim template sidik jari ke perangkat.

POST
EnrollFace

Daftarkan template wajah jika didukung.

POST
EnrollCard

Tetapkan kartu RFID / proximity ke pengguna.

POST
SetUserPassword

Setel atau ubah PIN / kata sandi perangkat.

POST
CopyUsers

Gandakan pengguna & template antarperangkat.

POST
ResendUser

Kirim ulang data pengguna ke antrean perangkat.

🔒

Kontrol akses · 5

POST
OpenDoor

Picu relai pintu, turnstile, flap, swing, atau palang boom secara real-time.

POST
LockDoor

Kunci / tahan pintu di bawah kendali Anda.

GET
GetDoorStatus

Baca status terbuka / tertutup saat ini.

POST
SetAccessSchedule

Tentukan jendela akses berbasis waktu.

GET
GetAccessEvents

Log event masuk / keluar dan pintu.

📡

Manajemen perangkat · 8

GET
ListDevices

Inventaris semua perangkat yang terhubung.

GET
GetDeviceInfo

Model, firmware, kapasitas, dan penghitung.

GET
CheckDeviceHealth

Status online, terakhir terlihat, dan kedalaman antrean.

GET
PingConnection

Pastikan perangkat dapat dijangkau saat ini.

POST
SyncDeviceTime

Selaraskan jam perangkat dengan server.

POST
RebootDevice

Mulai ulang perangkat dari jarak jauh.

POST
ResetDeviceQueue

Bersihkan perintah yang macet dari antrean.

GET
GetCommandStatus

Lacak status perintah yang berada di antrean.

🔌

Real-time, callback & sistem · 5

POST
RegisterCallback

Langganan URL webhook untuk event langsung.

PUSH
attendance.new

Dipicu pada setiap absen, secara real-time.

PUSH
device.status

Transisi online / offline & kondisi perangkat.

PUSH
enrollment.update

Konfirmasi saat template tiba di perangkat.

GET
MigrationStatus

Lacak progres migrasi perangkat / data secara massal.

Respons yang dapat diprediksi

Kode status yang bisa Anda jadikan percabangan

KodeArtiTindakan
200BerhasilProses payload JSON.
401AuthToken tidak valid atau tidak adaPeriksa kunci API dan pemasangan perangkat.
404Perangkat atau pengguna tidak ditemukanPeriksa nomor seri / kode karyawan.
409Perangkat offline / diantrekanPerintah diantrekan; lakukan polling GetCommandStatus.
429Dibatasi lajuKurangi frekuensi dan coba lagi dengan jitter.

Siap memanggil endpoint pertama Anda?

Panduan cepat mengantar Anda dari kunci API hingga log absensi pertama dalam hitungan menit.