RESTful API: lệnh từ máy chủ của bạn đến thiết bị

Các lệnh máy chủ của bạn gửi đến thiết bị thông qua Gateway, kèm JSON yêu cầu và phản hồi cho từng lệnh.

RESTful API Máy chủ của bạn → Thiết bị · Thao tác 12–38

#12

LoadLog

RESTful APIMáy chủ → Thiết bị

Lấy log chấm công từ thiết bị trong một khoảng thời gian. Khoảng tối đa khuyến nghị: 30 ngày.

Yêu cầu — POST đến endpoint RESTful của bạn

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

Phản hồi — từ thiết bị

{
  "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 APIMáy chủ → Thiết bị

Lấy thông tin phần cứng, giới hạn dung lượng, số lượng người dùng/template đã đăng ký và ngày hiệu lực giấy phép từ thiết bị.

Yêu cầu — POST đến endpoint RESTful của bạn

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

Phản hồi — từ thiết bị

{
  "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 APIMáy chủ → Thiết bị

Đăng ký người dùng mới với số thẻ/RFID là thông tin xác thực duy nhất.

Yêu cầu

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

Phản hồi

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

#15

AddUserWithPassword

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng mới với PIN/mật khẩu dạng số là thông tin xác thực duy nhất.

Yêu cầu

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

Phản hồi

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

#16

AddUserWithFace

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng bằng template khuôn mặt. Data là JPEG mã hóa Base64 hoặc dữ liệu nhị phân riêng theo thiết bị. Size là độ dài byte.

Yêu cầu

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

Phản hồi

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

#17

AddUserWithFingerPrint

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với một template vân tay. Index chỉ định vị trí ngón tay (0–9).

Yêu cầu

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

Phản hồi

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

#18

AddUserWithPalm

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng bằng template tĩnh mạch lòng bàn tay. Data là dữ liệu nhị phân lòng bàn tay mã hóa Base64.

Yêu cầu

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

Phản hồi

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

#19

AddUserWithUserPhoto

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với ảnh hồ sơ lưu trên thiết bị. Data là JPEG mã hóa Base64.

Yêu cầu

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

Phản hồi

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

#20

AddUserWithCardAndPassword

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với cả số thẻ và PIN — hai mục trong mảng Template.

Yêu cầu

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

Phản hồi

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

#21

AddUserWithCardAndFingerPrint

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với số thẻ và một template vân tay.

Yêu cầu

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

Phản hồi

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

#22

AddUserWithPalmAndFace

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với cả template tĩnh mạch lòng bàn tay và template khuôn mặt.

Yêu cầu

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

Phản hồi

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

#23

AddUserWithCard_FingerPrintAndFace

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với thẻ, vân tay và khuôn mặt — ba template.

Yêu cầu

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

Phản hồi

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

#24

AddUserWithCard_PalmAndUserPhoto

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với thẻ, tĩnh mạch lòng bàn tay và ảnh hồ sơ — ba template.

Yêu cầu

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

Phản hồi

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

#25

AddUserWithCard_Password_FingerPrintAndFace

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với thẻ, mật khẩu, vân tay và khuôn mặt — bốn template.

Yêu cầu

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

Phản hồi

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

#26

AddUserWithCard_Password_PalmAndUserPhoto

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với thẻ, mật khẩu, tĩnh mạch lòng bàn tay và ảnh hồ sơ — bốn template.

Yêu cầu

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

Phản hồi

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

#27

AddUserWithCard_FingerPrint_Password_Face_PalmAndUserPhoto

RESTful APIMáy chủ → Thiết bị

Đăng ký người dùng với đủ sáu loại thông tin xác thực — thẻ, vân tay, mật khẩu, khuôn mặt, lòng bàn tay và ảnh hồ sơ.

Yêu cầu

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

Phản hồi

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

#28

AddUserWithoutTemplate

RESTful APIMáy chủ → Thiết bị

Tạo bản ghi người dùng trên thiết bị mà không có dữ liệu sinh trắc học. Hữu ích để đăng ký trước, rồi đăng ký template riêng sau.

Yêu cầu

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

Phản hồi

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

#29

DeleteUser

RESTful APIMáy chủ → Thiết bị

Xóa một người dùng cụ thể cùng toàn bộ template sinh trắc học của họ khỏi thiết bị.

Yêu cầu

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

Phản hồi

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

#30

DeleteAllUser

RESTful APIMáy chủ → Thiết bị

Xóa toàn bộ người dùng và template sinh trắc học của họ khỏi thiết bị. Không thể hoàn tác.

Thao tác phá hủy dữ liệu. Toàn bộ người dùng và template đã đăng ký sẽ bị xóa vĩnh viễn khỏi thiết bị.

Yêu cầu

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

Phản hồi

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

#31

DeleteLogAll

RESTful APIMáy chủ → Thiết bị

Xóa toàn bộ log chấm công khỏi thiết bị. Bản ghi người dùng và template không bị ảnh hưởng.

Yêu cầu

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

Phản hồi

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

#32

DeleteAttendancePhoto

RESTful APIMáy chủ → Thiết bị

Xóa toàn bộ ảnh chấm công lưu trên thiết bị. Áp dụng cho thiết bị có khả năng chụp ảnh.

Yêu cầu

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

Phản hồi

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

#33

ResendAttendance

RESTful APIMáy chủ → Thiết bị

Yêu cầu thiết bị đẩy lại log chấm công trong một khoảng thời gian đến máy chủ của bạn qua Callback. Hữu ích để khôi phục các bản ghi bị bỏ lỡ.

Yêu cầu

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

Phản hồi

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

#34

ResendAllUser

RESTful APIMáy chủ → Thiết bị

Yêu cầu thiết bị đẩy lại toàn bộ dữ liệu người dùng đã đăng ký (hồ sơ và template) đến máy chủ của bạn qua Callback.

Yêu cầu

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

Phản hồi

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

#35

EnrollFingerPrint

RESTful APIMáy chủ → Thiết bị

Kích hoạt thiết bị bắt đầu phiên đăng ký vân tay trực tiếp trên thiết bị. Người dùng phải có mặt tại thiết bị.

Yêu cầu

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

Phản hồi

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

#36

UpdateAccessTime

RESTful APIMáy chủ → Thiết bị

Đặt khung thời gian truy cập cho người dùng. Người dùng chỉ có thể xác thực trong khoảng bắt đầu–kết thúc đã chỉ định.

Yêu cầu

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

Phản hồi

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

#37

EnableUser

RESTful APIMáy chủ → Thiết bị

Bật lại người dùng đã bị vô hiệu hóa trước đó, khôi phục khả năng xác thực của họ trên thiết bị.

Yêu cầu

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

Phản hồi

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

#38

DisableUser

RESTful APIMáy chủ → Thiết bị

Vô hiệu hóa người dùng mà không xóa. Bản ghi và template được giữ lại nhưng việc xác thực bị chặn cho đến khi bật lại.

Yêu cầu

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

Phản hồi

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