خانه / محصولات / APIها / Biometric Gateway Web API

API

Biometric Gateway Web API

Q: آیا برای استفاده از Web API باید نرمافزاری روی شبکه محلی نصب کنم؟

خیر. ارتباط از طریق HTTP میان دستگاه و سرور شما انجام میشود. تا زمانی که دستگاه به اینترنت متصل باشد، بدون هیچ نرمافزار محلی، پایگاه داده یا رایانه میتوانید حضور و غیاب را دریافت و کاربران را مدیریت کنید.

Q: اگر سرور من IP عمومی ندارد، میتوانم از API استفاده کنم؟

بله. از LoadLog API برای دریافت لاگهای حضور و غیاب در یک بازه زمانی مشخص و بنا به درخواست استفاده کنید، به شرطی که دستگاه به اینترنت متصل باشد.

Biometric Gateway Web API (با نام Universal Biometric Web API 3.0 نیز شناخته می‌شود) هر دستگاه پشتیبانی‌شده اثر انگشت، چهره، کف دست، رگ، عنبیه، شبکیه، کارت یا گذرواژه را به یک endpoint متصل به ابر تبدیل می‌کند که برنامه شما از هر نقطه جهان می‌تواند با آن ارتباط بگیرد. ترددها را در لحظه وقوع به‌صورت بلادرنگ دریافت کنید و کاربران را از راه دور روی دستگاه مدیریت کنید، همه روی یک قرارداد ساده REST به‌علاوه Callback.

شروع کنید مستندات توسعه‌دهندگان

نمای کلی

هر دستگاه حضور و غیاب یا کنترل تردد بیومتریک متصل به اینترنت را مستقیماً از طریق HTTP به برنامه وب خود متصل کنید — بدون نرم‌افزار محلی، رایانه یا پایگاه داده.

Web API شاخص Cams ارتباط ماشین به سرور میان دستگاه‌های بیومتریک نصب‌شده از راه دور و برنامه سرور شما را ممکن می‌کند. دستگاه به اینترنت متصل می‌شود، حضور و غیاب به‌صورت بلادرنگ به URL Callback (webhook) شما ارسال می‌شود و سرور شما عملیات دستگاه مانند افزودن یا حذف کاربر، ارسال الگوها، ارسال عکس‌ها و بارگذاری لاگ‌های تردد را از طریق فراخوانی‌های RESTful انجام می‌دهد. نیازی به نصب نرم‌افزار دسکتاپ، اجرای پایگاه داده محلی یا روشن نگه داشتن یک رایانه در LAN نیست. این API مستقل از پایگاه داده است و با هر زبان بک‌اند کار می‌کند.

APIRESTCallback/Webhook (HTTP POST)MQTT (مسیر اتصال پایدار EMQX)PHPPythonJavaNode.js

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

Callback (webhook) — تردد بلادرنگ

# Your Callback URL receives every punch in real time
POST https://yourapp.com/cams/callback
{
  "DeviceSN": "SN7A2300583",
  "EmployeeCode": "1042",
  "AttendanceLog": "2026-06-21 09:02:14",
  "Type": "face",
  "Direction": "CheckIn"
}

قابلیت‌ها

چه کاری انجام می‌دهد

حضور و غیاب بلادرنگ

ترددها در لحظه‌ای که روی دستگاه ثبت می‌شوند به URL Callback شما ارسال می‌شوند.

مدیریت از راه دور کاربران

کاربران را از سرور خود با فراخوانی‌های RESTful اضافه، حذف، مسدود و جابه‌جا کنید و الگوها یا عکس‌ها را به دستگاه‌ها بفرستید.

دریافت چندروشی

یک قرارداد واحد ورودی‌های اثر انگشت، چهره، کف دست، رگ، عنبیه، شبکیه، کارت و گذرواژه را پوشش می‌دهد.

تاب‌آوری در حالت آفلاین

ترددهای آفلاین روی دستگاه بافر می‌شوند و پس از برقراری دوباره اتصال به ترتیب بازپخش می‌شوند.

انتقال رمزگذاری‌شده

رمزگذاری AES-256 داده خام را می‌توان برای هر دستگاه فعال کرد تا تبادل داده امن باشد.

امکانات

همه‌چیز در بسته

Callback (webhook) API ترددهای بلادرنگ حضور و غیاب را از دستگاه به سرور شما می‌رساند، بدون تأخیر polling
RESTful API برای عملیات سرور به دستگاه: Add User، Add User with Templates، Add User Photo، Delete User، Delete All Users، Load Punchlog و بیشتر (38 عملیات)
در هر تردد چند نوع ورودی را ثبت می‌کند: اثر انگشت، چهره، کارت، کف دست، رگ انگشت، عنبیه، شبکیه، گذرواژه، به‌علاوه پرچم‌های دمای بدن و ماسک چهره در جایی که سخت‌افزار پشتیبانی کند
انواع تردد شامل CheckIn، CheckOut، BreakIn، BreakOut، OverTimeIn، OverTimeOut، MealIn، MealOut
ترددهای آفلاین را مدیریت می‌کند: داده‌های صف‌شده هنگام اتصال دوباره دستگاه به‌ترتیب ارسال می‌شوند
رمزگذاری اختیاری AES-256 برای همه داده‌های خام مبادله‌شده، با کلید امنیتی تنظیم‌شده در API Monitor
LoadLog API به برنامه‌های غیرسروری و فقط LAN اجازه می‌دهد تا 30 روز تاریخچه حضور و غیاب را بنا به درخواست دریافت کنند
کدهای وضعیت مستند برای مدیریت قدرتمند خطا، همراه با AuthToken اختصاصی هر دستگاه و ردیابی OperationID برای پشتیبانی و تطبیق

با Biometric Gateway Web API بسازید

یک کلید بگیرید، مستندات را بخوانید و عرضه کنید. تیم ما در اولین یکپارچه‌سازی شما کمک می‌کند.

گفتگو با یک مهندس WhatsApp

پرسش‌های متداول

آیا برای استفاده از Web API باید نرم‌افزاری روی شبکه محلی نصب کنم؟

خیر. ارتباط از طریق HTTP میان دستگاه و سرور شما انجام می‌شود. تا زمانی که دستگاه به اینترنت متصل باشد، بدون هیچ نرم‌افزار محلی، پایگاه داده یا رایانه می‌توانید حضور و غیاب را دریافت و کاربران را مدیریت کنید.

Web API از کدام ورودی‌های بیومتریک پشتیبانی می‌کند؟

اثر انگشت، چهره، کارت، کف دست، رگ انگشت، عنبیه، شبکیه و گذرواژه، به‌علاوه داده‌های دمای بدن و ماسک چهره در جایی که سخت‌افزار ارائه کند.

تفاوت Callback API و RESTful API چیست؟

Callback API ارتباط بلادرنگ دستگاه به سرور است که از طریق URLی که روی سرور خود در دسترس می‌گذارید انجام می‌شود (بدون تأخیر). RESTful API ارتباط سرور به دستگاه است که برای مدیریت دستگاه روی endpoint شرکت Cams فراخوانی می‌کنید و تأخیر آن تا حدود 15 ثانیه است.

اگر سرور من IP عمومی ندارد، می‌توانم از API استفاده کنم؟

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