Ana sayfa / API başvurusu

Biometric Gateway API

Her cihaz için tek sözleşme. Beş yetenek grubunda 38 işlem; eşzamanlı REST çağrıları ve gerçek zamanlı Callback webhook'ları olarak sunulur.

🌐

Temel URL

Tüm REST çağrıları, sürümlü tek bir ana bilgisayara yapılır.

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

🔑

Kimlik doğrulama

Her istek, hesabınıza ve cihazınıza özel bir AuthToken taşır. Anahtarlar geliştirici portalından verilir.

📦

Format

Form kodlamalı veya JSON istekler. Yanıtlar, öngörülebilir alanlar ve hata kodlarıyla JSON'dur.

Entegre etmenin iki yolu

Siz sorduğunuzda REST. Olay olduğunda Callback.

REST

İstek / yanıt

Gateway'i çağırırsınız ve anında yanıt alırsınız. Devam kayıtlarını çekmek, kullanıcıları listelemek, birini kaydetmek veya talep üzerine kapı açmak için ideal.

  • Eşzamanlı ve öngörülebilir
  • Senkronizasyonlar, raporlar ve yönetici işlemleri için harika
  • Her dilden veya cURL ile çalışır
CALLBACK

Gerçek zamanlı webhook'lar

Bir URL kaydedin; gateway, bir cihaz bildirdiği anda olayları size iletir — polling yok, hata durumunda otomatik yeniden denemelerle.

  • Anlık devam ve durum olayları
  • Cron job yok, kaçırılan giriş-çıkış yok
  • Endpoint'iniz onaylayana kadar yeniden dener

İşlemler

38 işlemin tamamı

İşlevlerine göre gruplandırılmıştır. Adlar, arkadaki gateway endpoint'leriyle 1:1 eşleşir.

📊

Devam · 8

GET
GetAttendanceByDate

Hesap genelinde bir tarih aralığındaki tüm giriş-çıkışlar.

GET
GetAttendanceByEmployee

Tek bir personel kodunun bir dönemdeki kayıtları.

GET
GetAttendanceByDevice

Tek bir cihaz seri numarasının yakaladığı giriş-çıkışlar.

GET
GetAttendanceSummary

Gün ve personel bazında özet (giriş/çıkış, saat).

GET
GetFirstInLastOut

Personel ve gün başına ilk giriş / son çıkış çifti.

GET
GetTodayAttendance

Bugünkü giriş-çıkışların canlı anlık görüntüsü.

GET
GetAttendancePhoto

Destekleniyorsa, bir giriş-çıkışa eklenen yakalama fotoğrafları.

GET
ExportAttendance

Bordro ve mutabakat için toplu dışa aktarma.

👤

Kullanıcılar ve kayıt · 12

POST
AddUser

Bir veya birden fazla cihazda kullanıcı oluşturun.

POST
UpdateUser

Ad, rol, geçerlilik veya yetkileri düzenleyin.

POST
DeleteUser

Bir kullanıcıyı cihazdan kaldırın.

GET
FindUser

Kullanıcıyı koduna göre, isteğe bağlı kimlik bilgileriyle bulun.

GET
ListUsers

Bir cihaza kayıtlı herkesi listeleyin.

GET
ListUserDevices

Kullanıcının hangi cihazlarda bulunduğunu gösterin.

POST
EnrollFingerprint

Cihaza parmak izi şablonu gönderin.

POST
EnrollFace

Destekleniyorsa yüz şablonu kaydedin.

POST
EnrollCard

Kullanıcıya RFID / yakınlık kartı atayın.

POST
SetUserPassword

Cihaz PIN'ini / parolasını belirleyin veya değiştirin.

POST
CopyUsers

Kullanıcıları ve şablonları cihazlar arasında kopyalayın.

POST
ResendUser

Kullanıcı verisini cihazın kuyruğuna yeniden iletin.

🔒

Erişim kontrolü · 5

POST
OpenDoor

Kapı rölesini, turnikeyi, flap, swing veya bom bariyeri gerçek zamanlı tetikleyin.

POST
LockDoor

Bir kapıyı kontrolünüz altında kilitleyin / tutun.

GET
GetDoorStatus

Güncel açık / kapalı durumunu okuyun.

POST
SetAccessSchedule

Zamana dayalı erişim aralıkları tanımlayın.

GET
GetAccessEvents

Giriş / çıkış ve kapı olayları kaydı.

📡

Cihaz yönetimi · 8

GET
ListDevices

Bağlı tüm cihazların envanteri.

GET
GetDeviceInfo

Model, donanım yazılımı, kapasite ve sayaçlar.

GET
CheckDeviceHealth

Çevrimiçi durum, son görülme ve kuyruk derinliği.

GET
PingConnection

Bir cihazın şu anda erişilebilir olduğunu doğrulayın.

POST
SyncDeviceTime

Cihaz saatini sunucuyla eşitleyin.

POST
RebootDevice

Bir cihazı uzaktan yeniden başlatın.

POST
ResetDeviceQueue

Kuyrukta takılan komutları temizleyin.

GET
GetCommandStatus

Kuyruğa alınmış bir komutun durumunu izleyin.

🔌

Gerçek zamanlı, callback ve sistem · 5

POST
RegisterCallback

Canlı olaylar için bir webhook URL'sine abone olun.

PUSH
attendance.new

Her giriş-çıkışta gerçek zamanlı tetiklenir.

PUSH
device.status

Çevrimiçi / çevrimdışı ve sağlık durumu geçişleri.

PUSH
enrollment.update

Bir şablon cihaza ulaştığında onay.

GET
MigrationStatus

Toplu cihaz / veri taşıma ilerlemesini izleyin.

Öngörülebilir yanıtlar

Üzerinde koşul kurabileceğiniz durum kodları

KodAnlamNe yapmalı
200BaşarılıJSON verisini işleyin.
401Geçersiz veya eksik AuthTokenAPI anahtarını ve cihaz eşleşmesini kontrol edin.
404Cihaz veya kullanıcı bulunamadıSeri numarasını / personel kodunu doğrulayın.
409Cihaz çevrimdışı / kuyruğa alındıKomut kuyruğa alındı; GetCommandStatus ile sorgulayın.
429İstek sınırına takıldıBekleyin ve jitter ile yeniden deneyin.

İlk endpoint'inizi çağırmaya hazır mısınız?

Hızlı başlangıç kılavuzu, API anahtarından ilk devam kaydınıza dakikalar içinde götürür.