APIهای Callback: رویدادهای بلادرنگ از دستگاه به سرور شما

هر رویدادی که دستگاه به callback URL شما می‌فرستد، همراه با JSON دریافتی سرور و پاسخی که باید برگرداند.

APIهای Callback از دستگاه به سرور شما · عملیات 1–11

#01

ManuallyUserDeleted

API نوع Callbackدستگاه ← سرور

هنگامی فعال می‌شود که کاربری مستقیماً روی خود دستگاه به‌صورت دستی حذف شود. شامل 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

API نوع Callbackدستگاه ← سرور

هنگامی فعال می‌شود که تاریخ/ساعت دستگاه به‌صورت دستی تغییر کند. مقدار جدید تنظیم‌شده را گزارش می‌دهد.

درخواست — ارسال‌شده به سرور شما

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

API نوع Callbackدستگاه ← سرور

پروفایل کاربر (نام/نوع) روی دستگاه به‌روزرسانی شده — بدون تغییر بیومتریک. آرایه 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

API نوع Callbackدستگاه ← سرور

کاربر روی دستگاه با الگوی کارت/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

API نوع Callbackدستگاه ← سرور

کاربر روی دستگاه با 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

API نوع Callbackدستگاه ← سرور

کاربر با اثر انگشت به‌روزرسانی شده است. 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

API نوع Callbackدستگاه ← سرور

کاربر با الگوی چهره به‌روزرسانی شده است. 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

API نوع Callbackدستگاه ← سرور

کاربر با الگوی رگ کف دست به‌روزرسانی شده است. 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

API نوع Callbackدستگاه ← سرور

کاربر با عکس پروفایل به‌روزرسانی شده است. 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

API نوع Callbackدستگاه ← سرور

رویداد ثبت تردد بلادرنگ همراه با تصویر ثبت‌شده (برای دستگاه‌های دارای قابلیت ثبت عکس). 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

API نوع Callbackدستگاه ← سرور

رویداد اصلی حضور بلادرنگ — در هر ثبت تردد فعال می‌شود. شامل نوع، روش ورودی، دما و وضعیت ماسک صورت است.

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