Ein Vertrag für jedes Gerät. 38 Operationen in fünf Funktionsgruppen, verfügbar als synchrone REST-Aufrufe und als Callback-Webhooks in Echtzeit.
Alle REST-Aufrufe gehen an einen einzigen versionierten Host.
https://api.camsbiometrics.com/v3/
Jede Anfrage enthält einen AuthToken, der auf Ihr Konto und Ihr Gerät begrenzt ist. Schlüssel werden im Entwicklerportal ausgestellt.
Formularkodierte oder JSON-Anfragen. Antworten sind JSON mit vorhersehbaren Feldern und Fehlercodes.
Zwei Wege zur Integration
Sie rufen das Gateway auf und erhalten sofort eine Antwort. Ideal, um Anwesenheit abzurufen, Benutzer aufzulisten, jemanden zu registrieren oder eine Tür auf Abruf zu öffnen.
Registrieren Sie eine URL, und das Gateway sendet Ihnen Ereignisse in dem Moment, in dem ein Gerät sie meldet – ohne Polling, mit automatischen Wiederholungen bei Fehlern.
Operationen
Gruppiert nach ihrer Funktion. Die Namen entsprechen 1:1 den zugrunde liegenden Gateway-Endpoints.
Alle Stempelungen innerhalb eines Datumsbereichs im gesamten Konto.
Logs eines einzelnen Mitarbeitercodes über einen Zeitraum.
Von einer Geräte-Seriennummer erfasste Stempelungen.
Zusammenfassung pro Tag und Mitarbeiter (Kommen/Gehen, Stunden).
Paar aus erstem Kommen und letztem Gehen pro Mitarbeiter und Tag.
Live-Momentaufnahme der heutigen Stempelungen.
An eine Stempelung angehängte Aufnahmefotos, sofern unterstützt.
Massenexport für Lohnabrechnung & Abstimmung.
Einen Benutzer auf einem oder mehreren Geräten anlegen.
Name, Rolle, Gültigkeit oder Berechtigungen bearbeiten.
Einen Benutzer von einem Gerät entfernen.
Einen Benutzer per Code nachschlagen, optional mit Credentials.
Alle auf einem Gerät registrierten Personen auflisten.
Anzeigen, auf welchen Geräten ein Benutzer vorhanden ist.
Ein Fingerabdruck-Template auf das Gerät übertragen.
Ein Gesichts-Template registrieren, sofern unterstützt.
Einem Benutzer eine RFID- / Proximity-Karte zuweisen.
Eine Geräte-PIN bzw. ein Passwort festlegen oder ändern.
Benutzer & Templates zwischen Geräten klonen.
Die Daten eines Benutzers erneut in die Warteschlange eines Geräts einstellen.
Ein Türrelais, Drehkreuz, eine Schwenk-, Pendel- oder Schrankenanlage in Echtzeit auslösen.
Eine Tür unter Ihrer Kontrolle sperren bzw. gesperrt halten.
Den aktuellen Zustand offen / geschlossen auslesen.
Zeitbasierte Zutrittsfenster definieren.
Protokoll der Ein-/Austritts- und Türereignisse.
Inventar aller verbundenen Geräte.
Modell, Firmware, Kapazität und Zähler.
Online-Status, zuletzt gesehen und Warteschlangentiefe.
Die Erreichbarkeit eines Geräts jetzt prüfen.
Die Geräteuhr mit dem Server abgleichen.
Ein Gerät aus der Ferne neu starten.
Festhängende Befehle aus der Warteschlange entfernen.
Den Status eines Befehls in der Warteschlange verfolgen.
Eine Webhook-URL für Live-Ereignisse abonnieren.
Wird bei jeder Stempelung in Echtzeit ausgelöst.
Online-/Offline- & Zustandswechsel.
Bestätigung, sobald ein Template auf einem Gerät angekommen ist.
Fortschritt von Massenmigrationen von Geräten / Daten verfolgen.
Vorhersehbare Antworten
| Code | Bedeutung | Was zu tun ist |
|---|---|---|
200 | Erfolg | JSON-Payload verarbeiten. |
401 | Ungültiger oder fehlender AuthToken | API-Schlüssel und Gerätekopplung prüfen. |
404 | Gerät oder Benutzer nicht gefunden | Seriennummer / Mitarbeitercode prüfen. |
409 | Gerät offline / in der Warteschlange | Der Befehl ist eingereiht; GetCommandStatus abfragen. |
429 | Ratenbegrenzung erreicht | Pausieren und mit Jitter erneut versuchen. |
Der Schnellstart führt Sie in wenigen Minuten vom API-Schlüssel zu Ihrem ersten Anwesenheits-Log.
Wir verwenden Cookies, um den Datenverkehr zu messen und BiometricAPI.com zu verbessern. Analysen bleiben deaktiviert, bis Sie zustimmen. Mehr erfahren.