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.
Tüm REST çağrıları, sürümlü tek bir ana bilgisayara yapılır.
https://api.camsbiometrics.com/v3/
Her istek, hesabınıza ve cihazınıza özel bir AuthToken taşır. Anahtarlar geliştirici portalından verilir.
Form kodlamalı veya JSON istekler. Yanıtlar, öngörülebilir alanlar ve hata kodlarıyla JSON'dur.
Entegre etmenin iki yolu
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.
Bir URL kaydedin; gateway, bir cihaz bildirdiği anda olayları size iletir — polling yok, hata durumunda otomatik yeniden denemelerle.
İşlemler
İşlevlerine göre gruplandırılmıştır. Adlar, arkadaki gateway endpoint'leriyle 1:1 eşleşir.
Hesap genelinde bir tarih aralığındaki tüm giriş-çıkışlar.
Tek bir personel kodunun bir dönemdeki kayıtları.
Tek bir cihaz seri numarasının yakaladığı giriş-çıkışlar.
Gün ve personel bazında özet (giriş/çıkış, saat).
Personel ve gün başına ilk giriş / son çıkış çifti.
Bugünkü giriş-çıkışların canlı anlık görüntüsü.
Destekleniyorsa, bir giriş-çıkışa eklenen yakalama fotoğrafları.
Bordro ve mutabakat için toplu dışa aktarma.
Bir veya birden fazla cihazda kullanıcı oluşturun.
Ad, rol, geçerlilik veya yetkileri düzenleyin.
Bir kullanıcıyı cihazdan kaldırın.
Kullanıcıyı koduna göre, isteğe bağlı kimlik bilgileriyle bulun.
Bir cihaza kayıtlı herkesi listeleyin.
Kullanıcının hangi cihazlarda bulunduğunu gösterin.
Cihaza parmak izi şablonu gönderin.
Destekleniyorsa yüz şablonu kaydedin.
Kullanıcıya RFID / yakınlık kartı atayın.
Cihaz PIN'ini / parolasını belirleyin veya değiştirin.
Kullanıcıları ve şablonları cihazlar arasında kopyalayın.
Kullanıcı verisini cihazın kuyruğuna yeniden iletin.
Kapı rölesini, turnikeyi, flap, swing veya bom bariyeri gerçek zamanlı tetikleyin.
Bir kapıyı kontrolünüz altında kilitleyin / tutun.
Güncel açık / kapalı durumunu okuyun.
Zamana dayalı erişim aralıkları tanımlayın.
Giriş / çıkış ve kapı olayları kaydı.
Bağlı tüm cihazların envanteri.
Model, donanım yazılımı, kapasite ve sayaçlar.
Çevrimiçi durum, son görülme ve kuyruk derinliği.
Bir cihazın şu anda erişilebilir olduğunu doğrulayın.
Cihaz saatini sunucuyla eşitleyin.
Bir cihazı uzaktan yeniden başlatın.
Kuyrukta takılan komutları temizleyin.
Kuyruğa alınmış bir komutun durumunu izleyin.
Canlı olaylar için bir webhook URL'sine abone olun.
Her giriş-çıkışta gerçek zamanlı tetiklenir.
Çevrimiçi / çevrimdışı ve sağlık durumu geçişleri.
Bir şablon cihaza ulaştığında onay.
Toplu cihaz / veri taşıma ilerlemesini izleyin.
Öngörülebilir yanıtlar
| Kod | Anlam | Ne yapmalı |
|---|---|---|
200 | Başarılı | JSON verisini işleyin. |
401 | Geçersiz veya eksik AuthToken | API anahtarını ve cihaz eşleşmesini kontrol edin. |
404 | Cihaz veya kullanıcı bulunamadı | Seri numarasını / personel kodunu doğrulayın. |
409 | Cihaz ç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. |
Hızlı başlangıç kılavuzu, API anahtarından ilk devam kaydınıza dakikalar içinde götürür.
BiometricAPI.com'u geliştirmek ve trafiği ölçmek için çerezler kullanıyoruz. Siz kabul edene kadar analitik kapalı kalır. Daha fazla bilgi.