Callback API: события в реальном времени от устройства к вашему серверу

Все события, которые устройство отправляет на ваш callback URL, с JSON, получаемым вашим сервером, и ответом, который он должен вернуть.

Callback API Устройство → ваш сервер · Операции 1–11

#01

ManuallyUserDeleted

Callback APIУстройство → сервер

Срабатывает, когда пользователь удалён вручную непосредственно на устройстве. Содержит UserID и время удаления.

Запрос — отправляется на ваш сервер

{
  "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"
    }
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#02

ManuallyDateModified

Callback APIУстройство → сервер

Срабатывает при ручном изменении даты/времени устройства. Передаёт новое установленное значение.

Запрос — отправляется на ваш сервер

{
  "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"
    }
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#03

ManuallyUserUpdatedWithoutTemplate

Callback APIУстройство → сервер

Профиль пользователя (имя/тип) обновлён на устройстве — биометрия не менялась. Массив Template пуст.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#04

ManuallyUserUpdatedWithCard

Callback APIУстройство → сервер

Пользователь обновлён на устройстве с шаблоном карты/RFID. В Data передаётся номер карты.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#05

ManuallyUserUpdatedWithPassword

Callback APIУстройство → сервер

Пользователь обновлён на устройстве с PIN-кодом/паролем. Data — строка с цифровым PIN-кодом.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#06

ManuallyUserUpdatedWithFingerPrint

Callback APIУстройство → сервер

Пользователь обновлён с отпечатком пальца. Index = слот пальца 0–9, Size = длина в байтах, Data = двоичные данные в Base64.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#07

ManuallyUserUpdatedWithFace

Callback APIУстройство → сервер

Пользователь обновлён с шаблоном лица. Data — JPEG в кодировке Base64 или собственный двоичный формат лица (зависит от устройства).

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#08

ManuallyUserUpdatedWithPalm

Callback APIУстройство → сервер

Пользователь обновлён с шаблоном вен ладони. Data — двоичные данные ладони в кодировке Base64.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#09

ManuallyUserUpdatedWithUserPhoto

Callback APIУстройство → сервер

Пользователь обновлён с фото профиля. Data — JPEG в кодировке Base64.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#10

RealTimeAttendancePhoto

Callback APIУстройство → сервер

Событие отметки в реальном времени с сохранённым снимком (для устройств с фотосъёмкой). LogPhoto — JPEG в кодировке Base64.

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }

#11

RealTimePunchLog

Callback APIУстройство → сервер

Основное событие посещаемости в реальном времени — срабатывает при каждой отметке. Включает тип, способ ввода, температуру и статус наличия маски на лице.

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

Запрос — отправляется на ваш сервер

{
  "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"
  }
}

Ответ — который должен вернуть ваш сервер

{ "status": "done" }