Jeden kontrakt dla każdego urządzenia. 38 operacji w pięciu grupach funkcji, dostępnych jako synchroniczne wywołania REST i webhooki Callback w czasie rzeczywistym.
Wszystkie wywołania REST kierowane są do jednego wersjonowanego hosta.
https://api.camsbiometrics.com/v3/
Każde żądanie zawiera AuthToken przypisany do Twojego konta i urządzenia. Klucze wydawane są z portalu deweloperskiego.
Żądania w formacie form-encoded lub JSON. Odpowiedzi w JSON z przewidywalnymi polami i kodami błędów.
Dwa sposoby integracji
Wywołujesz bramę i od razu dostajesz odpowiedź. Idealne do pobierania obecności, wyświetlania użytkowników, rejestrowania osoby czy otwierania drzwi na żądanie.
Zarejestruj URL, a brama wyśle Ci zdarzenia w chwili, gdy urządzenie je zgłosi — bez odpytywania, z automatycznymi ponowieniami w razie niepowodzenia.
Operacje
Pogrupowane według przeznaczenia. Nazwy odpowiadają 1:1 endpointom bramy.
Wszystkie odbicia w zakresie dat dla całego konta.
Logi dla jednego kodu pracownika w danym okresie.
Odbicia zarejestrowane przez jedno urządzenie o danym numerze seryjnym.
Podsumowanie dzienne dla pracownika (wejście/wyjście, godziny).
Para pierwsze wejście / ostatnie wyjście dla pracownika na dzień.
Migawka dzisiejszych odbić na żywo.
Zdjęcia dołączone do odbicia, jeśli są obsługiwane.
Eksport zbiorczy do płac i uzgodnień.
Utwórz użytkownika na jednym lub wielu urządzeniach.
Edytuj imię i nazwisko, rolę, ważność lub uprawnienia.
Usuń użytkownika z urządzenia.
Wyszukaj użytkownika po kodzie, opcjonalnie z poświadczeniami.
Wyświetl wszystkich zarejestrowanych na urządzeniu.
Pokaż, na których urządzeniach istnieje użytkownik.
Wyślij wzorzec odcisku palca na urządzenie.
Zarejestruj wzorzec twarzy, jeśli jest obsługiwany.
Przypisz użytkownikowi kartę RFID / zbliżeniową.
Ustaw lub zmień PIN / hasło na urządzeniu.
Klonuj użytkowników i wzorce między urządzeniami.
Ponownie dostarcz dane użytkownika do kolejki urządzenia.
Wyzwól w czasie rzeczywistym przekaźnik drzwi, bramkę obrotową, skrzydłową, wahadłową lub szlaban.
Zablokuj / przytrzymaj drzwi pod swoją kontrolą.
Odczytaj bieżący stan otwarcia / zamknięcia.
Zdefiniuj przedziały czasowe dostępu.
Log wejść / wyjść i zdarzeń drzwi.
Inwentarz wszystkich podłączonych urządzeń.
Model, firmware, pojemność i liczniki.
Stan online, ostatnia aktywność i głębokość kolejki.
Potwierdź dostępność urządzenia w tej chwili.
Zsynchronizuj zegar urządzenia z serwerem.
Zrestartuj urządzenie zdalnie.
Usuń zablokowane polecenia z kolejki.
Śledź stan polecenia w kolejce.
Zasubskrybuj URL webhooka dla zdarzeń na żywo.
Wywoływane przy każdym odbiciu, w czasie rzeczywistym.
Przejścia online / offline i zmiany stanu urządzenia.
Potwierdzenie, że wzorzec trafił na urządzenie.
Śledź postęp zbiorczej migracji urządzeń / danych.
Przewidywalne odpowiedzi
| Kod | Znaczenie | Co zrobić |
|---|---|---|
200 | Sukces | Przetwórz ładunek JSON. |
401 | Nieprawidłowy lub brakujący AuthToken | Sprawdź klucz API i parowanie urządzenia. |
404 | Nie znaleziono urządzenia lub użytkownika | Zweryfikuj numer seryjny / kod pracownika. |
409 | Urządzenie offline / w kolejce | Polecenie jest w kolejce; odpytaj GetCommandStatus. |
429 | Przekroczono limit żądań | Odczekaj i ponów z losowym opóźnieniem (jitter). |
Szybki start przeprowadzi Cię od klucza API do pierwszego logu obecności w kilka minut.
Używamy plików cookie do pomiaru ruchu i ulepszania BiometricAPI.com. Analityka pozostaje wyłączona, dopóki jej nie zaakceptujesz. Dowiedz się więcej.