APIs de callback: eventos en tiempo real del dispositivo a su servidor

Todos los eventos que un dispositivo envía a su URL de callback, con el JSON que recibe su servidor y la respuesta que debe devolver.

APIs de callback Dispositivo → Su servidor · Operaciones 1–11

#01

ManuallyUserDeleted

API de callbackDispositivo → Servidor

Se activa cuando un usuario se elimina manualmente directamente en el dispositivo. Contiene el UserID y la hora de eliminación.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "OperationID": "oy1kjign3sm7",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 07:42:02 GMT +0000",
    "UserDeleted": {
      "UserID": "1",
      "OperationTime": "2020-09-17 13:12:02 GMT +0530"
    }
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#02

ManuallyDateModified

API de callbackDispositivo → Servidor

Se activa cuando se cambia manualmente la fecha/hora del dispositivo. Informa del nuevo valor establecido.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "OperationID": "1aci5f5o6kbi1",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 07:52:31 GMT +0000",
    "DateModified": {
      "ModifiedTo": "2020-09-17 10:22:24 GMT +0530",
      "OperationTime": "2020-09-17 13:22:31 GMT +0530"
    }
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#03

ManuallyUserUpdatedWithoutTemplate

API de callbackDispositivo → Servidor

Perfil de usuario (nombre/tipo) actualizado en el dispositivo, sin cambio biométrico. El arreglo Template está vacío.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "UserID": "1",
      "FirstName": "jency",
      "LastName": "mary",
      "UserType": "User",
      "OperationTime": "2020-09-16 18:45:34 GMT +0530",
      "Template": []
    },
    "LabelName": "Burj Khalifa",
    "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "1vsyboxnuuorq",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-16 13:15:33 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#04

ManuallyUserUpdatedWithCard

API de callbackDispositivo → Servidor

Usuario actualizado en el dispositivo con una plantilla de tarjeta/RFID. Data contiene el número de tarjeta.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "UserID": "8", "FirstName": "", "LastName": "", "UserType": "User",
      "OperationTime": "2020-09-17 15:33:38 GMT +0530",
      "Template": [{ "Type": "Card", "UserID": "8", "Data": "9804445" }]
    },
    "LabelName": "Burj Khalifa",
    "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "oldcu1ekxdbz",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 10:03:38 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#05

ManuallyUserUpdatedWithPassword

API de callbackDispositivo → Servidor

Usuario actualizado en el dispositivo con un PIN/contraseña. Data es la cadena del PIN numérico.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "UserID": "8", "FirstName": "", "LastName": "", "UserType": "User",
      "OperationTime": "2020-09-17 15:33:38 GMT +0530",
      "Template": [{ "Type": "Password", "UserID": "8", "Data": "124445" }]
    },
    "LabelName": "Burj Khalifa", "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "oldcu1ekxdbz",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 10:03:38 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#06

ManuallyUserUpdatedWithFingerPrint

API de callbackDispositivo → Servidor

Usuario actualizado con una huella dactilar. Index = ranura del dedo 0–9, Size = longitud en bytes, Data = binario en Base64.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "OperationTime": "2020-09-17 12:48:28 GMT +0530",
      "Template": [{
        "Type": "Fingerprint", "UserID": "2",
        "Size": "1176", "Index": "6",
        "Data": "SjNTUzIxAAADcHcECAUHCc7Q..."
      }]
    },
    "LabelName": "Burj Khalifa", "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "vq01h140jswo",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 13:15:31 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#07

ManuallyUserUpdatedWithFace

API de callbackDispositivo → Servidor

Usuario actualizado con una plantilla facial. Data es un JPEG codificado en Base64 o un binario facial propietario (según el dispositivo).

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "OperationTime": "2020-09-17 19:04:55 GMT +0530",
      "Template": [{
        "Type": "Face", "UserID": "2",
        "Size": "28112", "Index": "0",
        "Data": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
      }]
    },
    "LabelName": "Burj Khalifa", "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "5qwmu986vm7c",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 13:15:31 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#08

ManuallyUserUpdatedWithPalm

API de callbackDispositivo → Servidor

Usuario actualizado con una plantilla de venas de la palma. Data es el binario de la palma codificado en Base64.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "OperationTime": "2020-09-17 19:10:12 GMT +0530",
      "Template": [{
        "Type": "Palm", "UserID": "2", "Index": "0",
        "Data": "apUBEOAHv98IAAwAAc/qAgzWDlDL..."
      }]
    },
    "LabelName": "Burj Khalifa", "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "p3rm9kqx1yz0",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 13:40:12 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#09

ManuallyUserUpdatedWithUserPhoto

API de callbackDispositivo → Servidor

Usuario actualizado con una foto de perfil. Data es un JPEG codificado en Base64.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "UserUpdated": {
      "UserID": "5", "FirstName": "Alex", "LastName": "Thomas",
      "UserType": "User",
      "OperationTime": "2020-09-17 20:00:00 GMT +0530",
      "Template": [{ "Type": "UserPhoto", "UserID": "5", "Data": "/9j/4AAQSkZJRgABAQAAAQABAAD..." }]
    },
    "LabelName": "Burj Khalifa", "SerialNumber": "ZHM11xxxxxxxx",
    "OperationID": "up9h2bxk7q11",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 14:30:00 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#10

RealTimeAttendancePhoto

API de callbackDispositivo → Servidor

Evento de marcación en tiempo real con una captura de imagen (para dispositivos con captura de fotos). LogPhoto es un JPEG codificado en Base64.

Solicitud — enviada a su servidor

{
  "RealTime": {
    "Log": {
      "UserID": "3",
      "LogPhoto": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
      "LogTime": "2020-09-17 07:48:30 GMT +0530"
    },
    "OperationID": "x58636uon24u",
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 04:19:18 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }

#11

RealTimePunchLog

API de callbackDispositivo → Servidor

Evento principal de asistencia en tiempo real: se dispara en cada marcación. Incluye el tipo, el método de entrada, la temperatura y el estado de la mascarilla facial.

Type: CheckIn · CheckOut · BreakOut · BreakIn · OverTimeIn · OverTimeOut · MealIn · MealOut | InputType: Fingerprint · Face · Palm · Card · Password

Solicitud — enviada a su servidor

{
  "RealTime": {
    "OperationID": "9nu1wak5616p",
    "LabelName": "Burj Khalifa",
    "SerialNumber": "ZHM11xxxxxxxx",
    "PunchLog": {
      "Type": "CheckOut",
      "Temperature": "36.8",
      "FaceMask": false,
      "InputType": "Fingerprint",
      "UserId": "2",
      "LogTime": "2020-09-17 07:48:22 GMT +0530"
    },
    "AuthToken": "COJJ7eiiPBGUfmIQPvh2PJWWDLX7OuKs",
    "Time": "2020-09-17 04:19:03 GMT +0000"
  }
}

Respuesta — su servidor debe devolver

{ "status": "done" }