APIs de callback: eventos em tempo real do equipamento para o seu servidor

Todos os eventos que um equipamento envia para a sua URL de callback, com o JSON que seu servidor recebe e a resposta que ele deve retornar.

APIs de callback Equipamento → Seu servidor · Operações 1–11

#01

ManuallyUserDeleted

API de callbackEquipamento → Servidor

Disparado quando um usuário é excluído manualmente diretamente no equipamento. Contém o UserID e a hora da exclusão.

Requisição — enviada ao seu 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"
    }
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#02

ManuallyDateModified

API de callbackEquipamento → Servidor

Disparado quando a data/hora do equipamento é alterada manualmente. Informa o novo valor definido.

Requisição — enviada ao seu 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"
    }
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#03

ManuallyUserUpdatedWithoutTemplate

API de callbackEquipamento → Servidor

Perfil do usuário (nome/tipo) atualizado no equipamento, sem alteração biométrica. O array Template está vazio.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#04

ManuallyUserUpdatedWithCard

API de callbackEquipamento → Servidor

Usuário atualizado no equipamento com um template de cartão/RFID. Data contém o número do cartão.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#05

ManuallyUserUpdatedWithPassword

API de callbackEquipamento → Servidor

Usuário atualizado no equipamento com um PIN/senha. Data é a string do PIN numérico.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#06

ManuallyUserUpdatedWithFingerPrint

API de callbackEquipamento → Servidor

Usuário atualizado com impressão digital. Index = posição do dedo 0–9, Size = tamanho em bytes, Data = binário em Base64.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#07

ManuallyUserUpdatedWithFace

API de callbackEquipamento → Servidor

Usuário atualizado com um template facial. Data é um JPEG codificado em Base64 ou um binário facial proprietário (depende do equipamento).

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#08

ManuallyUserUpdatedWithPalm

API de callbackEquipamento → Servidor

Usuário atualizado com um template de veias da palma. Data é o binário da palma codificado em Base64.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#09

ManuallyUserUpdatedWithUserPhoto

API de callbackEquipamento → Servidor

Usuário atualizado com uma foto de perfil. Data é um JPEG codificado em Base64.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#10

RealTimeAttendancePhoto

API de callbackEquipamento → Servidor

Evento de marcação em tempo real com uma captura de imagem (para equipamentos com captura de foto). LogPhoto é um JPEG codificado em Base64.

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }

#11

RealTimePunchLog

API de callbackEquipamento → Servidor

Evento principal de ponto em tempo real: disparado a cada marcação. Inclui o tipo, o método de entrada, a temperatura e o status de máscara facial.

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

Requisição — enviada ao seu 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"
  }
}

Resposta — seu servidor deve retornar

{ "status": "done" }