Un unico contratto per ogni dispositivo. 38 operazioni in cinque gruppi di funzionalità, disponibili come chiamate REST sincrone e webhook Callback in tempo reale.
Tutte le chiamate REST vanno a un unico host versionato.
https://api.camsbiometrics.com/v3/
Ogni richiesta include un AuthToken associato al tuo account e al tuo dispositivo. Le chiavi vengono rilasciate dal portale sviluppatori.
Richieste in form-encoded o JSON. Le risposte sono in JSON con campi e codici di errore prevedibili.
Due modi per integrare
Chiami il gateway e ottieni subito una risposta. Perfetto per recuperare le presenze, elencare gli utenti, registrare una persona o aprire una porta su richiesta.
Registra un URL e il gateway ti invia gli eventi nell'istante in cui un dispositivo li segnala — senza polling, con nuovi tentativi automatici in caso di errore.
Operazioni
Raggruppate per funzione. I nomi corrispondono 1:1 agli endpoint del gateway sottostanti.
Tutte le timbrature in un intervallo di date per l'intero account.
Log di un singolo codice dipendente in un periodo.
Timbrature acquisite da un dispositivo con un dato numero di serie.
Riepilogo per giorno e per dipendente (entrata/uscita, ore).
Coppia primo ingresso / ultima uscita per dipendente e per giorno.
Istantanea in tempo reale delle timbrature di oggi.
Foto acquisite e associate a una timbratura, dove supportato.
Esportazione massiva per paghe e riconciliazione.
Crea un utente su uno o più dispositivi.
Modifica nome, ruolo, validità o privilegi.
Rimuove un utente da un dispositivo.
Cerca un utente per codice, con credenziali opzionali.
Elenca tutti gli utenti registrati su un dispositivo.
Mostra su quali dispositivi esiste un utente.
Invia un template di impronta al dispositivo.
Registra un template del volto, dove supportato.
Assegna a un utente una tessera RFID / di prossimità.
Imposta o modifica il PIN / la password del dispositivo.
Clona utenti e template tra dispositivi.
Rinvia i dati di un utente alla coda di un dispositivo.
Attiva in tempo reale il relè di una porta, un tornello, una barriera a ribalta, a battente o a sbarra.
Blocca / mantiene chiusa una porta sotto il tuo controllo.
Legge lo stato attuale aperto / chiuso.
Definisce le fasce orarie di accesso.
Log degli eventi di ingresso / uscita e delle porte.
Inventario di ogni dispositivo connesso.
Modello, firmware, capacità e contatori.
Stato online, ultima connessione e profondità della coda.
Conferma subito la raggiungibilità di un dispositivo.
Allinea l'orologio del dispositivo con il server.
Riavvia un dispositivo da remoto.
Elimina dalla coda i comandi bloccati.
Segue lo stato di un comando in coda.
Iscrive un URL webhook per gli eventi live.
Si attiva a ogni timbratura, in tempo reale.
Passaggi online / offline e variazioni di stato.
Conferma quando un template arriva su un dispositivo.
Segue l'avanzamento della migrazione massiva di dispositivi / dati.
Risposte prevedibili
| Codice | Significato | Cosa fare |
|---|---|---|
200 | Operazione riuscita | Elabora il payload JSON. |
401 | AuthToken non valido o mancante | Controlla la chiave API e l'associazione del dispositivo. |
404 | Dispositivo o utente non trovato | Verifica il numero di serie / il codice dipendente. |
409 | Dispositivo offline / in coda | Il comando è in coda; esegui il polling di GetCommandStatus. |
429 | Limite di richieste superato | Rallenta e riprova con jitter. |
La guida rapida ti accompagna in pochi minuti dalla chiave API al tuo primo log di presenze.
Utilizziamo i cookie per misurare il traffico e migliorare BiometricAPI.com. Le analisi restano disattivate finché non accetti. Scopri di più.