Acasă / Referință API

Biometric Gateway API

Un singur contract pentru fiecare dispozitiv. 38 de operațiuni în cinci grupuri de funcționalități, disponibile ca apeluri REST sincrone și ca webhook-uri Callback în timp real.

🌐

URL de bază

Toate apelurile REST se fac către o singură gazdă versionată.

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

🔑

Autentificare

Fiecare cerere conține un AuthToken limitat la contul și dispozitivul dumneavoastră. Cheile se emit din portalul pentru dezvoltatori.

📦

Format

Cereri codificate ca formular sau JSON. Răspunsurile sunt JSON, cu câmpuri și coduri de eroare previzibile.

Două moduri de integrare

REST când cereți. Callback când se întâmplă.

REST

Cerere / răspuns

Apelați gateway-ul și primiți imediat un răspuns. Ideal pentru preluarea prezenței, listarea utilizatorilor, înrolarea cuiva sau deschiderea unei uși la cerere.

  • Sincron și previzibil
  • Excelent pentru sincronizări, rapoarte și acțiuni administrative
  • Funcționează din orice limbaj sau cu cURL
CALLBACK

Webhook-uri în timp real

Înregistrați un URL, iar gateway-ul vă trimite evenimentele în clipa în care un dispozitiv le raportează — fără polling, cu reîncercări automate în caz de eșec.

  • Evenimente instantanee de prezență și stare
  • Fără joburi cron, fără pontaje pierdute
  • Reîncearcă până când endpoint-ul dumneavoastră confirmă primirea

Operațiuni

Toate cele 38 de operațiuni

Grupate după funcție. Denumirile corespund 1:1 endpoint-urilor gateway-ului.

📊

Prezență · 8

GET
GetAttendanceByDate

Toate pontajele dintr-un interval de date, la nivelul întregului cont.

GET
GetAttendanceByEmployee

Jurnale pentru un singur cod de angajat într-o perioadă.

GET
GetAttendanceByDevice

Pontajele captate de un dispozitiv cu un anumit număr de serie.

GET
GetAttendanceSummary

Sinteză pe zi și pe angajat (intrare/ieșire, ore).

GET
GetFirstInLastOut

Perechea prima intrare / ultima ieșire per angajat și zi.

GET
GetTodayAttendance

Instantaneu live al pontajelor de astăzi.

GET
GetAttendancePhoto

Fotografii captate și atașate unui pontaj, acolo unde este acceptat.

GET
ExportAttendance

Export în masă pentru salarizare și reconciliere.

👤

Utilizatori și înrolare · 12

POST
AddUser

Creați un utilizator pe unul sau mai multe dispozitive.

POST
UpdateUser

Modificați numele, rolul, valabilitatea sau privilegiile.

POST
DeleteUser

Eliminați un utilizator de pe un dispozitiv.

GET
FindUser

Căutați un utilizator după cod, cu credențiale opționale.

GET
ListUsers

Enumerați toate persoanele înrolate pe un dispozitiv.

GET
ListUserDevices

Afișați pe ce dispozitive există un utilizator.

POST
EnrollFingerprint

Trimiteți un șablon de amprentă către dispozitiv.

POST
EnrollFace

Înregistrați un șablon facial, acolo unde este acceptat.

POST
EnrollCard

Atribuiți un card RFID / de proximitate unui utilizator.

POST
SetUserPassword

Setați sau schimbați un PIN / o parolă a dispozitivului.

POST
CopyUsers

Clonați utilizatori și șabloane între dispozitive.

POST
ResendUser

Retrimiteți datele unui utilizator în coada unui dispozitiv.

🔒

Control al accesului · 5

POST
OpenDoor

Declanșați în timp real un releu de ușă, un turnichet, o barieră tip flap, swing sau boom.

POST
LockDoor

Blocați / mențineți o ușă sub controlul dumneavoastră.

GET
GetDoorStatus

Citiți starea curentă, deschis / închis.

POST
SetAccessSchedule

Definiți intervale de acces bazate pe timp.

GET
GetAccessEvents

Jurnal al evenimentelor de intrare / ieșire și de ușă.

📡

Gestionarea dispozitivelor · 8

GET
ListDevices

Inventarul tuturor dispozitivelor conectate.

GET
GetDeviceInfo

Model, firmware, capacitate și contoare.

GET
CheckDeviceHealth

Stare online, ultima conectare și dimensiunea cozii.

GET
PingConnection

Confirmați acum că dispozitivul este accesibil.

POST
SyncDeviceTime

Aliniați ceasul dispozitivului cu cel al serverului.

POST
RebootDevice

Reporniți un dispozitiv de la distanță.

POST
ResetDeviceQueue

Eliminați comenzile blocate din coadă.

GET
GetCommandStatus

Urmăriți starea unei comenzi aflate în coadă.

🔌

Timp real, callback și sistem · 5

POST
RegisterCallback

Abonați un URL de webhook la evenimente live.

PUSH
attendance.new

Declanșat la fiecare pontaj, în timp real.

PUSH
device.status

Treceri online / offline și schimbări ale stării de funcționare.

PUSH
enrollment.update

Confirmare atunci când un șablon ajunge pe un dispozitiv.

GET
MigrationStatus

Urmăriți progresul migrării în masă a dispozitivelor / datelor.

Răspunsuri previzibile

Coduri de stare pe care vă puteți baza

CodSemnificațieCe trebuie făcut
200SuccesProcesați payload-ul JSON.
401AuthToken invalid sau lipsăVerificați cheia API și asocierea dispozitivului.
404Dispozitiv sau utilizator negăsitVerificați numărul de serie / codul angajatului.
409Dispozitiv offline / în coadăComanda este în coadă; interogați GetCommandStatus.
429Limită de cereri depășităAșteptați și reîncercați cu jitter.

Sunteți gata să apelați primul endpoint?

Ghidul de pornire rapidă vă duce de la cheia API la primul jurnal de prezență în doar câteva minute.