خانه / مرجع API

Biometric Gateway API

یک قرارداد برای همه دستگاه‌ها. 38 عملیات در پنج گروه قابلیت، در دسترس به‌صورت فراخوانی‌های همگام REST و webhookهای بلادرنگ Callback.

🌐

Base URL

همه فراخوانی‌های REST به یک میزبان نسخه‌بندی‌شده ارسال می‌شوند.

https://api.camsbiometrics.com/v3/

🔑

احراز هویت

هر درخواست یک AuthToken همراه دارد که به حساب و دستگاه شما محدود است. کلیدها از پورتال توسعه‌دهندگان صادر می‌شوند.

📦

قالب

درخواست‌ها به‌صورت form-encoded یا JSON. پاسخ‌ها JSON با فیلدها و کدهای خطای قابل پیش‌بینی هستند.

دو روش یکپارچه‌سازی

REST وقتی می‌پرسید. Callback وقتی رخ می‌دهد.

REST

درخواست / پاسخ

شما گیت‌وی را فرامی‌خوانید و بلافاصله پاسخ می‌گیرید. ایده‌آل برای دریافت حضور و غیاب، فهرست کردن کاربران، ثبت‌نام یک نفر یا باز کردن درب بنا به درخواست.

  • همگام و قابل پیش‌بینی
  • عالی برای همگام‌سازی، گزارش‌ها و اقدامات مدیریتی
  • در هر زبان یا با cURL کار می‌کند
CALLBACK

webhookهای بلادرنگ

یک URL ثبت کنید و گیت‌وی رویدادها را در همان لحظه که دستگاه گزارش می‌دهد برای شما ارسال می‌کند — بدون polling و با تلاش مجدد خودکار هنگام خطا.

  • رویدادهای لحظه‌ای حضور و غیاب و وضعیت
  • بدون cron job، بدون ازدست رفتن تردد
  • تلاش مجدد تا زمانی که endpoint شما دریافت را تأیید کند

عملیات

هر 38 عملیات

گروه‌بندی بر اساس کارکرد. نام‌ها دقیقاً با endpointهای گیت‌وی متناظرند.

📊

حضور و غیاب · 8

GET
GetAttendanceByDate

همه ترددها در یک بازه تاریخی در سطح حساب.

GET
GetAttendanceByEmployee

لاگ‌های یک کد کارمندی در یک دوره.

GET
GetAttendanceByDevice

ترددهای ثبت‌شده توسط دستگاهی با یک شماره سریال.

GET
GetAttendanceSummary

خلاصه روزانه به‌ازای هر کارمند (ورود/خروج، ساعت کار).

GET
GetFirstInLastOut

جفت اولین ورود / آخرین خروج برای هر کارمند در هر روز.

GET
GetTodayAttendance

تصویر لحظه‌ای ترددهای امروز.

GET
GetAttendancePhoto

عکس‌های ثبت‌شده همراه یک تردد، در صورت پشتیبانی.

GET
ExportAttendance

خروجی گروهی برای حقوق و دستمزد و تطبیق.

👤

کاربران و ثبت‌نام · 12

POST
AddUser

ایجاد کاربر روی یک یا چند دستگاه.

POST
UpdateUser

ویرایش نام، نقش، اعتبار یا سطح دسترسی.

POST
DeleteUser

حذف یک کاربر از دستگاه.

GET
FindUser

جستجوی کاربر با کد، همراه با اطلاعات احراز هویت اختیاری.

GET
ListUsers

فهرست همه افراد ثبت‌نام‌شده روی یک دستگاه.

GET
ListUserDevices

نمایش اینکه کاربر روی کدام دستگاه‌ها وجود دارد.

POST
EnrollFingerprint

ارسال الگوی اثر انگشت به دستگاه.

POST
EnrollFace

ثبت الگوی چهره در صورت پشتیبانی.

POST
EnrollCard

اختصاص کارت RFID / مجاورتی به یک کاربر.

POST
SetUserPassword

تنظیم یا تغییر PIN / گذرواژه دستگاه.

POST
CopyUsers

همسان‌سازی کاربران و الگوها بین دستگاه‌ها.

POST
ResendUser

ارسال دوباره اطلاعات کاربر به صف دستگاه.

🔒

کنترل تردد · 5

POST
OpenDoor

فعال‌سازی رله در، گیت گردان، گیت بالابر، گیت لولایی یا راه‌بند بازویی به‌صورت بلادرنگ.

POST
LockDoor

قفل کردن / نگه داشتن یک در تحت کنترل شما.

GET
GetDoorStatus

خواندن وضعیت فعلی باز / بسته.

POST
SetAccessSchedule

تعریف بازه‌های دسترسی زمان‌محور.

GET
GetAccessEvents

لاگ رویدادهای ورود / خروج و در.

📡

مدیریت دستگاه · 8

GET
ListDevices

فهرست همه دستگاه‌های متصل.

GET
GetDeviceInfo

مدل، فریمور، ظرفیت و شمارنده‌ها.

GET
CheckDeviceHealth

وضعیت آنلاین، آخرین اتصال و عمق صف.

GET
PingConnection

تأیید دسترس‌پذیری یک دستگاه در همین لحظه.

POST
SyncDeviceTime

هماهنگ‌سازی ساعت دستگاه با سرور.

POST
RebootDevice

راه‌اندازی مجدد دستگاه از راه دور.

POST
ResetDeviceQueue

پاک کردن دستورهای گیرکرده از صف.

GET
GetCommandStatus

پیگیری وضعیت یک دستور صف‌شده.

🔌

بلادرنگ، callback و سیستم · 5

POST
RegisterCallback

اشتراک یک URL وب‌هوک برای رویدادهای زنده.

PUSH
attendance.new

در هر تردد و به‌صورت بلادرنگ فعال می‌شود.

PUSH
device.status

تغییر وضعیت آنلاین / آفلاین و سلامت.

PUSH
enrollment.update

تأیید رسیدن یک الگو به دستگاه.

GET
MigrationStatus

پیگیری پیشرفت مهاجرت گروهی دستگاه / داده.

پاسخ‌های قابل پیش‌بینی

کدهای وضعیتی که می‌توانید روی آن‌ها شرط بگذارید

کدمعناچه باید کرد
200موفقpayload JSON را پردازش کنید.
401AuthToken نامعتبر یا ناموجودکلید API و جفت‌سازی دستگاه را بررسی کنید.
404دستگاه یا کاربر یافت نشدشماره سریال / کد کارمندی را بررسی کنید.
409دستگاه آفلاین / در صفدستور در صف است؛ GetCommandStatus را poll کنید.
429محدودیت نرخکمی صبر کنید و با jitter دوباره تلاش کنید.

آماده فراخوانی اولین endpoint هستید؟

شروع سریع شما را در چند دقیقه از کلید API به اولین لاگ حضور و غیاب می‌رساند.