RESTful API: команди від вашого сервера до пристрою

Команди, які ваш сервер надсилає пристрою через шлюз, із JSON запиту та відповіді для кожної.

RESTful API Ваш сервер → пристрій · Операції 12–38

#12

LoadLog

RESTful APIСервер → пристрій

Отримує з пристрою журнали відміток відвідуваності за вказаний період. Рекомендований максимальний інтервал: 30 днів.

Запит — POST на ваш RESTful endpoint

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

Відповідь — від пристрою

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

RESTful APIСервер → пристрій

Отримує з пристрою відомості про обладнання, ліміти місткості, кількість зареєстрованих користувачів/шаблонів і дати ліцензій.

Запит — POST на ваш RESTful endpoint

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

Відповідь — від пристрою

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

RESTful APIСервер → пристрій

Реєструє нового користувача з номером картки/RFID як єдиним ідентифікатором.

Запит

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

Відповідь

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

#15

AddUserWithPassword

RESTful APIСервер → пристрій

Реєструє нового користувача з цифровим PIN-кодом/паролем як єдиним ідентифікатором.

Запит

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

Відповідь

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

#16

AddUserWithFace

RESTful APIСервер → пристрій

Реєструє користувача з шаблоном обличчя. Data — JPEG у кодуванні Base64 або двійкові дані формату конкретного пристрою. Size — довжина в байтах.

Запит

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

Відповідь

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

#17

AddUserWithFingerPrint

RESTful APIСервер → пристрій

Реєструє користувача з одним шаблоном відбитка пальця. Index визначає слот пальця (0–9).

Запит

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

Відповідь

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

#18

AddUserWithPalm

RESTful APIСервер → пристрій

Реєструє користувача з шаблоном вен долоні. Data — двійкові дані долоні в кодуванні Base64.

Запит

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

Відповідь

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

#19

AddUserWithUserPhoto

RESTful APIСервер → пристрій

Реєструє користувача з фото профілю, що зберігається на пристрої. Data — JPEG у кодуванні Base64.

Запит

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

Відповідь

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

#20

AddUserWithCardAndPassword

RESTful APIСервер → пристрій

Реєструє користувача з номером картки та PIN-кодом — два записи в масиві Template.

Запит

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

Відповідь

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

#21

AddUserWithCardAndFingerPrint

RESTful APIСервер → пристрій

Реєструє користувача з номером картки та одним шаблоном відбитка пальця.

Запит

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

Відповідь

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

#22

AddUserWithPalmAndFace

RESTful APIСервер → пристрій

Реєструє користувача із шаблонами вен долоні та обличчя.

Запит

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

Відповідь

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

#23

AddUserWithCard_FingerPrintAndFace

RESTful APIСервер → пристрій

Реєструє користувача з карткою, відбитком пальця та обличчям — три шаблони.

Запит

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

Відповідь

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

#24

AddUserWithCard_PalmAndUserPhoto

RESTful APIСервер → пристрій

Реєструє користувача з карткою, венами долоні та фото профілю — три шаблони.

Запит

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

Відповідь

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

#25

AddUserWithCard_Password_FingerPrintAndFace

RESTful APIСервер → пристрій

Реєструє користувача з карткою, паролем, відбитком пальця та обличчям — чотири шаблони.

Запит

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

Відповідь

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

#26

AddUserWithCard_Password_PalmAndUserPhoto

RESTful APIСервер → пристрій

Реєструє користувача з карткою, паролем, венами долоні та фото профілю — чотири шаблони.

Запит

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

Відповідь

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

#27

AddUserWithCard_FingerPrint_Password_Face_PalmAndUserPhoto

RESTful APIСервер → пристрій

Реєструє користувача з усіма шістьма типами ідентифікаторів — картка, відбиток пальця, пароль, обличчя, долоня та фото профілю.

Запит

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

Відповідь

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

#28

AddUserWithoutTemplate

RESTful APIСервер → пристрій

Створює на пристрої запис користувача без біометричних даних. Зручно для попередньої реєстрації перед окремим записом шаблонів.

Запит

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

Відповідь

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

#29

DeleteUser

RESTful APIСервер → пристрій

Видаляє з пристрою вказаного користувача та всі його біометричні шаблони.

Запит

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

Відповідь

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

#30

DeleteAllUser

RESTful APIСервер → пристрій

Видаляє з пристрою усіх користувачів та їхні біометричні шаблони. Незворотно.

Деструктивна операція. Усіх зареєстрованих користувачів і шаблони буде безповоротно видалено з пристрою.

Запит

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

Відповідь

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

#31

DeleteLogAll

RESTful APIСервер → пристрій

Очищає на пристрої всі журнали відміток відвідуваності. Записи користувачів і шаблони не зачіпаються.

Запит

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

Відповідь

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

#32

DeleteAttendancePhoto

RESTful APIСервер → пристрій

Видаляє всі фото відміток, що зберігаються на пристрої. Застосовується до пристроїв із функцією фотозйомки.

Запит

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

Відповідь

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

#33

ResendAttendance

RESTful APIСервер → пристрій

Доручає пристрою повторно надіслати журнали відвідуваності за вказаний період на ваш сервер через Callback. Корисно для відновлення пропущених записів.

Запит

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

Відповідь

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

#34

ResendAllUser

RESTful APIСервер → пристрій

Доручає пристрою повторно надіслати на ваш сервер через Callback усі дані зареєстрованих користувачів (профілі та шаблони).

Запит

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

Відповідь

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

#35

EnrollFingerPrint

RESTful APIСервер → пристрій

Запускає на пристрої сеанс реєстрації відбитка пальця. Користувач має перебувати безпосередньо біля пристрою.

Запит

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

Відповідь

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

#36

UpdateAccessTime

RESTful APIСервер → пристрій

Задає користувачеві вікно доступу з обмеженням за часом. Користувач може проходити автентифікацію лише в межах указаного діапазону від початку до кінця.

Запит

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

Відповідь

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

#37

EnableUser

RESTful APIСервер → пристрій

Знову вмикає раніше вимкненого користувача, відновлюючи його можливість проходити автентифікацію на пристрої.

Запит

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

Відповідь

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

#38

DisableUser

RESTful APIСервер → пристрій

Вимикає користувача без видалення. Запис і шаблони зберігаються, але автентифікація блокується до повторного ввімкнення.

Запит

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

Відповідь

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