API RESTful: comandi dal tuo server al dispositivo

I comandi che il tuo server invia a un dispositivo tramite la Gateway, con il JSON di richiesta e risposta per ciascuno.

API RESTful Il tuo server → Dispositivo · Operazioni 12–38

#12

LoadLog

API RESTfulServer → Dispositivo

Recupera dal dispositivo i log delle timbrature in un intervallo di tempo. Intervallo massimo consigliato: 30 giorni.

Richiesta — POST al tuo endpoint RESTful

{
  "Load": {
    "PunchLog": {
      "Filter": {
        "StartTime": "2020-09-17 00:01:33 GMT +0530",
        "EndTime": "2020-09-17 22:01:33 GMT +0530"
      }
    }
  },
  "OperationID": "j95xfejt3vr1",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta — dal dispositivo

{
  "Status": "done",
  "OperationID": "j95xfejt3vr1",
  "PunchLog": {
    "ReturnRowCount": "18",
    "Log": [
      { "Type": "CheckOut", "Temperature": 36.8, "InputType": "Face", "UserID": "2", "LogTime": "2020-09-17 16:53:43 GMT +0530", "FaceMask": false },
      { "Type": "CheckOut", "Temperature": 36.6, "InputType": "Palm", "UserID": "1", "LogTime": "2020-09-17 16:54:15 GMT +0530", "FaceMask": false },
      { "Type": "CheckIn",  "Temperature": 36.5, "InputType": "Fingerprint", "UserID": "3", "LogTime": "2020-09-17 09:01:44 GMT +0530", "FaceMask": false }
    ]
  }
}

#13

LoadDeviceInformation

API RESTfulServer → Dispositivo

Recupera dal dispositivo i dettagli hardware, i limiti di capacità, il numero di utenti/template registrati e le date di licenza.

Richiesta — POST al tuo endpoint RESTful

{
  "Load": { "DeviceInformation": "All" },
  "OperationID": "j95xfejt3vr1",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-08-28 12:01:33 GMT +0530"
}

Risposta — dal dispositivo

{
  "Status": "done",
  "OperationID": "j95xfejt3vr1",
  "StatusCode": 0,
  "DeviceInformation": {
    "DeviceModel": "Hawking Plus (f38+)",
    "Manufacturer": "Dheeram Innovations",
    "MacAddress": "00-01-A9-16-27-AB",
    "StartDate": "03/04/2024",
    "EndDate": "03/04/2025",
    "LastConnectedTime": "13-11-2025 18:03:48 GMT +0530",
    "RegisteredUsers": "0",
    "RegisteredFaces": "0",
    "RegisteredFingerprints": "0",
    "MaximumFacesSupported": "5000",
    "MaximumFingerprintsSupported": "10000",
    "MaximumAttendanceLogsSupported": "500000"
  }
}

#14

AddUserWithCard

API RESTfulServer → Dispositivo

Registra un nuovo utente con un numero di badge/RFID come unica credenziale.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "Card", "UserID": "100", "Data": "102836" }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#15

AddUserWithPassword

API RESTfulServer → Dispositivo

Registra un nuovo utente con un PIN/password numerico come unica credenziale.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "Password", "UserID": "100", "Data": "123456" }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#16

AddUserWithFace

API RESTfulServer → Dispositivo

Registra un utente con un template del volto. Data è un JPEG codificato Base64 o un binario specifico del dispositivo. Size è la lunghezza in byte.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "Face", "UserID": "100", "Size": "25072", "Index": "0", "Data": "/9j/4AAQSkZJRgABAQAAAQABAAD..." }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#17

AddUserWithFingerPrint

API RESTfulServer → Dispositivo

Registra un utente con un template di impronta digitale. Index indica la posizione del dito (0–9).

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "Fingerprint", "UserID": "100", "Size": "1176", "Index": "0", "Data": "TW9TUzIxAAAELC4ECAUHCc7Q..." }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#18

AddUserWithPalm

API RESTfulServer → Dispositivo

Registra un utente con un template delle vene del palmo. Data è il binario del palmo codificato Base64.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "Palm", "UserID": "100", "Index": "0", "Data": "apUBEOAHv98IAAwAAc/qAgzWDlDL..." }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#19

AddUserWithUserPhoto

API RESTfulServer → Dispositivo

Registra un utente con una foto del profilo salvata sul dispositivo. Data è un JPEG codificato Base64.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [{ "Type": "UserPhoto", "UserID": "100", "Data": "/9j/4AAQSkZJRgABAQAAAQABAAD..." }]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#20

AddUserWithCardAndPassword

API RESTfulServer → Dispositivo

Registra un utente con sia il numero di badge sia un PIN — due voci nell’array Template.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",     "UserID": "100", "Data": "102836" },
      { "Type": "Password", "UserID": "100", "Data": "123456" }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#21

AddUserWithCardAndFingerPrint

API RESTfulServer → Dispositivo

Registra un utente con un numero di badge e un template di impronta digitale.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",        "UserID": "100", "Data": "102836" },
      { "Type": "Fingerprint", "UserID": "100", "Size": "1176", "Index": "0", "Data": "TW9TUzIxAAAELC4E..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#22

AddUserWithPalmAndFace

API RESTfulServer → Dispositivo

Registra un utente con sia un template delle vene del palmo sia uno del volto.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Palm", "UserID": "100", "Index": "0", "Data": "apUBEOAHv98IAAwA..." },
      { "Type": "Face", "UserID": "100", "Size": "25072", "Index": "0", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#23

AddUserWithCard_FingerPrintAndFace

API RESTfulServer → Dispositivo

Registra un utente con badge, impronta digitale e volto — tre template.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",        "UserID": "100", "Data": "102836" },
      { "Type": "Fingerprint", "UserID": "100", "Size": "1176", "Index": "0", "Data": "TW9TUzIxAAAELC4E..." },
      { "Type": "Face",        "UserID": "100", "Size": "25072", "Index": "0", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#24

AddUserWithCard_PalmAndUserPhoto

API RESTfulServer → Dispositivo

Registra un utente con badge, vene del palmo e foto del profilo — tre template.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",      "UserID": "100", "Data": "102836" },
      { "Type": "Palm",      "UserID": "100", "Index": "0", "Data": "apUBEOAHv98IAAwA..." },
      { "Type": "UserPhoto", "UserID": "100", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#25

AddUserWithCard_Password_FingerPrintAndFace

API RESTfulServer → Dispositivo

Registra un utente con badge, password, impronta digitale e volto — quattro template.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",        "UserID": "100", "Data": "102836" },
      { "Type": "Password",    "UserID": "100", "Data": "123456" },
      { "Type": "Fingerprint", "UserID": "100", "Size": "1176", "Index": "0", "Data": "TW9TUzIxAAAELC4E..." },
      { "Type": "Face",        "UserID": "100", "Size": "25072", "Index": "0", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#26

AddUserWithCard_Password_PalmAndUserPhoto

API RESTfulServer → Dispositivo

Registra un utente con badge, password, vene del palmo e foto del profilo — quattro template.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",      "UserID": "100", "Data": "102836" },
      { "Type": "Password",  "UserID": "100", "Data": "123456" },
      { "Type": "Palm",      "UserID": "100", "Index": "0", "Data": "apUBEOAHv98IAAwA..." },
      { "Type": "UserPhoto", "UserID": "100", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#27

AddUserWithCard_FingerPrint_Password_Face_PalmAndUserPhoto

API RESTfulServer → Dispositivo

Registra un utente con tutti e sei i tipi di credenziale — badge, impronta digitale, password, volto, palmo e foto del profilo.

Richiesta

{
  "Add": {
    "User": { "UserID": "100", "FirstName": "Manu", "LastName": "Mona", "UserType": "USER" },
    "Template": [
      { "Type": "Card",        "UserID": "100", "Data": "102836" },
      { "Type": "Password",    "UserID": "100", "Data": "123456" },
      { "Type": "Fingerprint", "UserID": "100", "Size": "1176", "Index": "0", "Data": "TW9TUzIxAAAELC4E..." },
      { "Type": "Face",        "UserID": "100", "Size": "25072", "Index": "0", "Data": "/9j/4AAQSkZJRgAB..." },
      { "Type": "Palm",        "UserID": "100", "Index": "0",    "Data": "apUBEOAHv98IAAwA..." },
      { "Type": "UserPhoto",   "UserID": "100", "Data": "/9j/4AAQSkZJRgAB..." }
    ]
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#28

AddUserWithoutTemplate

API RESTfulServer → Dispositivo

Crea sul dispositivo un record utente senza dati biometrici. Utile per preregistrare prima di registrare i template separatamente.

Richiesta

{
  "Add": {
    "User": { "UserID": "1", "FirstName": "Manu", "LastName": "Mona", "UserType": "User" }
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#29

DeleteUser

API RESTfulServer → Dispositivo

Elimina dal dispositivo un utente specifico e tutti i suoi template biometrici.

Richiesta

{
  "Delete": { "User": { "UserID": "User123" } },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-11 16:15:31 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#30

DeleteAllUser

API RESTfulServer → Dispositivo

Elimina dal dispositivo tutti gli utenti e i relativi template biometrici. Irreversibile.

Distruttivo. Tutti gli utenti e i template registrati verranno cancellati definitivamente dal dispositivo.

Richiesta

{
  "Delete": { "User": "All" },
  "OperationID": "j95xfejt3vr1",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "j95xfejt3vr1", "StatusCode": 0 }

#31

DeleteLogAll

API RESTfulServer → Dispositivo

Cancella dal dispositivo tutti i log delle timbrature. I record utente e i template non vengono toccati.

Richiesta

{
  "Delete": { "Log": "All" },
  "OperationID": "j95xfejt3vr1",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "j95xfejt3vr1", "StatusCode": 0 }

#32

DeleteAttendancePhoto

API RESTfulServer → Dispositivo

Elimina tutte le foto delle timbrature salvate sul dispositivo. Si applica ai dispositivi con acquisizione foto.

Richiesta

{
  "Delete": { "PunchPhoto": "All" },
  "OperationID": "j95xfejt3vr1",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "j95xfejt3vr1", "StatusCode": 0 }

#33

ResendAttendance

API RESTfulServer → Dispositivo

Ordina al dispositivo di inviare di nuovo al tuo server, tramite Callback, i log di presenza di un intervallo di tempo. Utile per recuperare record mancanti.

Richiesta

{
  "OperationID": "j95xfejt3vr1",
  "Resend": {
    "PunchLog": {
      "Filter": {
        "StartTime": "2020-09-17 15:49:33 GMT +0530",
        "EndTime": "2020-09-17 16:20:33 GMT +0530"
      }
    }
  },
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "j95xfejt3vr1", "StatusCode": 0 }

#34

ResendAllUser

API RESTfulServer → Dispositivo

Ordina al dispositivo di inviare di nuovo al tuo server, tramite Callback, tutti i dati utente registrati (profili e template).

Richiesta

{
  "OperationID": "j95xfejt3vr1",
  "Resend": { "User": "All" },
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 12:01:33 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "j95xfejt3vr1", "StatusCode": 0 }

#35

EnrollFingerPrint

API RESTfulServer → Dispositivo

Avvia sul dispositivo una sessione di registrazione dell’impronta digitale. L’utente deve essere fisicamente presente davanti al dispositivo.

Richiesta

{
  "Enroll": {
    "User": { "UserID": "3", "Type": "Fingerprint", "FirstName": "Rajesh", "LastName": "Ragavendhar" }
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2025-09-25 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#36

UpdateAccessTime

API RESTfulServer → Dispositivo

Imposta una finestra di accesso a tempo per un utente. L’utente può autenticarsi solo nell’intervallo inizio–fine specificato.

Richiesta

{
  "Update": {
    "AccessTime": { "UserID": "20", "Start": "2022-07-11 00:00:00", "End": "2022-07-11 23:59:59" }
  },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-11 16:39:29 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#37

EnableUser

API RESTfulServer → Dispositivo

Riattiva un utente precedentemente disattivato, ripristinando la sua possibilità di autenticarsi sul dispositivo.

Richiesta

{
  "Update": { "User": { "UserID": "1", "Access": "enable" } },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }

#38

DisableUser

API RESTfulServer → Dispositivo

Disattiva un utente senza eliminarlo. Record e template vengono conservati, ma l’autenticazione è bloccata fino alla riattivazione.

Richiesta

{
  "Update": { "User": { "UserID": "1", "Access": "disable" } },
  "OperationID": "1jxpjeoasu8wl",
  "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
  "Time": "2020-09-17 11:09:09 GMT +0530"
}

Risposta

{ "Status": "done", "OperationID": "1jxpjeoasu8wl", "StatusCode": 0 }