Wprowadzenie
Cams Biometric Gateway — Web API 3.0
Cams Biometric Gateway to uniwersalne Biometric API, które łączy dowolne biometryczne urządzenie do rejestracji czasu pracy lub kontroli dostępu z Twoją aplikacją — ERP, HRMS, systemem płacowym, systemem zarządzania szkołą, oprogramowaniem na zamówienie lub przepływem pracy AI/automatyzacji. Obsługuje wszystkie główne marki urządzeń i zapewnia ustandaryzowane Biometric API typu JSON przez HTTP, niezależnie od sprzętu.
38 operacji — 11 Callback API (urządzenie → serwer) i 27 RESTful API (serwer → urządzenie). Wszystkie payloady to surowy JSON przez HTTP/HTTPS.
Obsługiwane są wszystkie urządzenia biometryczne. Urządzenia Cams, urządzenia zweryfikowane oraz marki innych producentów (ZKTeco, Suprema, Hikvision, Anviz, Morpho/IDEMIA, Virdi, Mantra, Nitgen, Realtime/Startek, Biomax, Secugen, eSSL, Matrix COSEC i inne). Wybierz
tryb połączenia odpowiedni dla Twojego środowiska.
Jak to działa
Biometric Gateway składa się z:
Serwer GatewayPlatforma w chmurze, obejmująca Cams Protocol Engine (translacja protokołów, normalizacja danych, buforowanie offline, uwierzytelnianie) oraz warstwę Standardised API, która zapewnia spójny interfejs dla Twojej aplikacji.
Protocol EngineGłówny silnik w serwerze Gateway, który komunikuje się z urządzeniami biometrycznymi, tłumaczy protokoły specyficzne dla producentów oraz obsługuje bezpieczne rejestrowanie transakcji danych i zarządzanie tożsamością.
Protocol Engine LiteWersja lokalna (on-premise), którą można zainstalować na własnym serwerze (Windows/Linux) w środowiskach wyłącznie LAN lub samodzielnie hostowanych. To samo API, wdrożone lokalnie.
Integruje się z
OdooERPNextSAPMicrosoft Dynamics
ZohoBitrix24
OrangeHRMBayZatPalmHRuKnowva
FedenaTeachmintEduBricz
RazorPayPayruler
n8nMakeZapier
Claude (MCP)GeminiChatGPT
Aplikacje webowe na zamówienie
Twoja aplikacja
ERP
HRMS
Płace
ERP dla szkół
Przepływ pracy AI (n8n, Zapier)
MCP — Claude · Gemini · ChatGPT
Aplikacje własne
Protocol Engine
Bezpieczne uwierzytelnianie
Rejestrowanie transakcji danych
Translacja protokołów
Bufor offline & kolejka
Szyfrowanie AES-256 · Weryfikacja Auth Token
Warstwa Standardised API
Zarządzanie tożsamością
Integracja AI / MCP
Dyspozytor callbacków
Router poleceń REST
Normalizacja danych · Obsługa protokołów wielu marek
Odcisk palca
·
Rozpoznawanie twarzy
·
Układ żył dłoni
·
Karta RFID
·
PIN
·
Kod QR / kod kreskowy
·
Śledzenie GPS
Urządzenia biometryczne — obsługiwane wszystkie marki
Cams
ZKTeco
Suprema
Hikvision
Anviz
Morpho / IDEMIA
Virdi
Mantra
Nitgen
Realtime
Biomax
Secugen
eSSL
Matrix
+ wiele innych
| Typ API | Kierunek | Opóźnienie | Zastosowanie |
|---|
| Callback API | Urządzenie → Twój serwer | Czas rzeczywisty / zerowe opóźnienie | Odbieranie odbić obecności i zdarzeń synchronizacji użytkowników |
| RESTful API | Twój serwer → urządzenie | ~15 sekund | Dodawanie/usuwanie użytkowników, pobieranie logów, rejestracja danych biometrycznych |
Wprowadzenie
Pierwsze kroki
Integracja w trzech krokach. Twój serwer potrzebuje publicznie dostępnego adresu URL, aby odbierać callbacki.
1
Skonfiguruj swój Callback URL
Zaloguj się do portalu API Monitor. Ustaw publiczny adres HTTPS swojego serwera jako Callback URL dla swoich urządzeń. Silnik API będzie wysyłał zdarzenia biometryczne metodą POST na ten endpoint w czasie rzeczywistym.
2
Odbieraj odbicia obecności
Twój endpoint odbiera żądanie POST z surowym ciałem JSON — dla Callback API nie są potrzebne parametry zapytania. Zweryfikuj AuthToken, przetwórz dane odbicia i odpowiedz {"status":"done"}.
3
Wywołuj RESTful API do zarządzania użytkownikami & urządzeniami
Wyślij metodą POST polecenie JSON na adres URL endpointu RESTful podany na Twoim koncie API Monitor, z parametrem zapytania stgid (Service Tag ID). Silnik kolejkuje polecenie, a urządzenie potwierdza je w ciągu ~15 sekund.
Format endpointu
| Typ API | Metoda | Sposób wysyłania |
|---|
| Callback API (przychodzące) |
POST |
Urządzenie wysyła dane POST na Twój skonfigurowany adres URL. Surowe ciało JSON; bez parametrów. |
| RESTful API (wychodzące) |
POST |
Wysyłasz POST na adres URL endpointu RESTful (znajdziesz go na koncie API Monitor) z ?stgid=YOUR_SERVICE_TAG_ID i surowym ciałem JSON. |
Zawsze odpowiadaj na żądania Callback natychmiast. Twój serwer musi zwrócić {"status":"done"} (HTTP 200), aby potwierdzić odbiór. Nie wykonuj ciężkiego przetwarzania przed odpowiedzią — dodaj je do kolejki.
Dokumentacja
Dokumentacja API
Dokumentacja jest podzielona tematycznie. Zacznij od zgodności urządzeń, a następnie przejdź do operacji callback i REST.
Obsługiwane urządzenia i tryby połączeniaKtóre urządzenia obsługuje Gateway, jak każde z nich się łączy (Native Push lub Hybrid Push) oraz jakie operacje API są dostępne w każdym trybie.
Dokumentacja API: architektura, pola i kody statusuElementy wspólne dla każdej operacji: przepływ żądań, wspólne pola JSON, typy szablonów, kody statusu, porty i szyfrowanie payloadu.
Callback API: zdarzenia w czasie rzeczywistym z urządzenia do Twojego serweraKażde zdarzenie wysyłane przez urządzenie na Twój callback URL, wraz z JSON-em odbieranym przez serwer i odpowiedzią, którą musi on zwrócić.
RESTful API: polecenia z Twojego serwera do urządzeniaPolecenia wysyłane przez serwer do urządzenia za pośrednictwem Gateway, z przykładowym JSON żądania i odpowiedzi dla każdego z nich.
Lokalne testowanie APIJak odbierać callbacki urządzeń na komputerze deweloperskim i testować polecenia REST w Postman przed wdrożeniem.
Przykład w PHP: zapis biometrycznej rejestracji czasu pracy w MySQLDziałający handler callbacków w PHP, który zapisuje odbicia obecności w MySQL, w trzech krokach.
Prompty do generatorów kodu AISkopiuj prompt do swojego asystenta AI, aby wygenerować kod integracji dla własnego stosu technologicznego.
FAQ, SDK i kosztyNajczęstsze pytania integratorów oraz zasady działania SDK i cennika API.
