Eén contract voor elk apparaat. 38 operaties in vijf functiegroepen, beschikbaar als synchrone REST-aanroepen en realtime Callback-webhooks.
Alle REST-aanroepen gaan naar één host met versienummer.
https://api.camsbiometrics.com/v3/
Elk verzoek bevat een AuthToken die is afgebakend tot uw account en apparaat. Sleutels worden uitgegeven via het developerportaal.
Formulier-gecodeerde of JSON-verzoeken. Responses zijn JSON met voorspelbare velden en foutcodes.
Twee manieren om te integreren
U roept de gateway aan en krijgt direct antwoord. Perfect om aanwezigheid op te halen, gebruikers te tonen, iemand te registreren of op verzoek een deur te openen.
Registreer een URL en de gateway pusht events naar u op het moment dat een apparaat ze meldt — geen polling, met automatische nieuwe pogingen bij falen.
Operaties
Gegroepeerd naar functie. Namen komen 1:1 overeen met de onderliggende gateway-endpoints.
Alle punches binnen een datumbereik voor het hele account.
Logs van één medewerkercode over een periode.
Punches vastgelegd door één apparaatserienummer.
Samenvatting per dag en per medewerker (in/uit, uren).
First-in/last-out-paar per medewerker per dag.
Live momentopname van de punches van vandaag.
Opnamefoto's bij een punch, indien ondersteund.
Bulkexport voor payroll en afstemming.
Maak een gebruiker aan op een of meer apparaten.
Wijzig naam, rol, geldigheid of rechten.
Verwijder een gebruiker van een apparaat.
Zoek een gebruiker op code, optioneel met inloggegevens.
Toon iedereen die op een apparaat is geregistreerd.
Toon op welke apparaten een gebruiker voorkomt.
Push een vingerafdruksjabloon naar het apparaat.
Registreer een gezichtssjabloon, indien ondersteund.
Wijs een RFID-/proximitykaart toe aan een gebruiker.
Stel een pincode/wachtwoord voor het apparaat in of wijzig het.
Kloon gebruikers en sjablonen tussen apparaten.
Lever de gegevens van een gebruiker opnieuw af in de wachtrij van een apparaat.
Activeer in realtime een deurrelais, tourniquet, flap-, zwaai- of slagboom.
Vergrendel/houd een deur onder uw controle.
Lees de huidige status open/gesloten.
Definieer tijdgebonden toegangsvensters.
Log van in-/uitgang en deurevents.
Inventaris van elk gekoppeld apparaat.
Model, firmware, capaciteit en tellers.
Online-status, laatst gezien en wachtrijdiepte.
Bevestig nu of een apparaat bereikbaar is.
Synchroniseer de klok van het apparaat met de server.
Start een apparaat op afstand opnieuw op.
Wis vastgelopen commando's uit de wachtrij.
Volg de status van een commando in de wachtrij.
Abonneer een webhook-URL op live events.
Wordt bij elke punch in realtime geactiveerd.
Online-/offline- en gezondheidsovergangen.
Bevestiging wanneer een sjabloon op een apparaat aankomt.
Volg de voortgang van bulkmigratie van apparaten/data.
Voorspelbare responses
| Code | Betekenis | Wat te doen |
|---|---|---|
200 | Geslaagd | Verwerk de JSON-payload. |
401 | Ongeldige of ontbrekende AuthToken | Controleer de API-sleutel en de koppeling met het apparaat. |
404 | Apparaat of gebruiker niet gevonden | Controleer het serienummer / de medewerkercode. |
409 | Apparaat offline / in wachtrij | Commando staat in de wachtrij; poll GetCommandStatus. |
429 | Rate limit bereikt | Wacht even en probeer opnieuw met jitter. |
De quickstart leidt u in enkele minuten van API-sleutel naar uw eerste aanwezigheidslog.
Wij gebruiken cookies om verkeer te meten en BiometricAPI.com te verbeteren. Analytics blijven uit totdat u accepteert. Meer informatie.