هر دستگاه بیومتریکی که به دروازه بیومتریک Cams متصل میشود، این کار را از طریق یکی از دو حالت Push انجام میدهد. حالتی که دستگاه شما از آن استفاده میکند، تعیین میکند کدام APIها در دسترس هستند، رویدادها چگونه ارسال میشوند و زیرساخت شما باید چگونه پیکربندی شود. این راهنما هر متغیر این تصمیم را از نوع دستگاه تا روش ارتباطی و توپولوژی استقرار بررسی میکند تا پیش از شروع ساخت، مسیر درست را انتخاب کنید.
اولین پرسش: چه نوع دستگاهی را متصل میکنید؟
پیش از انتخاب روش ارتباطی یا توپولوژی استقرار، باید به یک پرسش اساسیتر پاسخ دهید: آیا دستگاه شما یک دستگاه Cams Biometrics است، یا دستگاهی است که در پورتال توسعهدهندگان Cams تأیید شده است؟
پاسخ به این پرسش، حالت Push شما را کاملاً تعیین میکند. اگر پاسخ بله باشد، از Native Push استفاده میکنید و نیازی به تصمیمگیری بیشتر نیست. اگر پاسخ خیر باشد، وارد قلمرو Hybrid Push میشوید و مجموعهای از تصمیمهای اضافی پیش رو خواهید داشت.
حالت ۱
Native Push
برای تمام دستگاههای Cams Biometrics و هر دستگاهی که در developer.camsbiometrics.com بهعنوان دستگاه تأییدشده فهرست شده باشد. دستگاه بهطور مستقیم و از طریق اینترنت با دروازه بیومتریک ارتباط برقرار میکند و نیازی به راهاندازی اضافی ندارد.
هر ۳۸ عملیات
Callback API کامل
RESTful API کامل
حالت ۲
Hybrid Push
برای سایر دستگاههای تأییدنشده. شما روش ارتباطی و توپولوژی استقرار را انتخاب میکنید که با محیط شما سازگار باشد. در دسترس بودن API به ترکیبی که انتخاب میکنید بستگی دارد.
۳ روش ارتباطی
۲ گزینه توپولوژی
دسترسی متغیر به API
Native Push: تصویر کامل
دستگاههای Native Push بدون هیچ پیکربندی اضافی، بهجز اتصال دستگاه به اینترنت، به دسترسی کامل به هر ۳۸ عملیات دروازه دسترسی دارند. Callback API رویدادها را بدون تأخیر ارسال میکند. دستورات RESTful API تقریباً در ۱۵ ثانیه اجرا میشوند. نیازی به SDK، نرمافزار محلی یا تصمیمگیری درباره توپولوژی نیست.
آشنایی با Hybrid Push: سه روش ارتباطی
اگر دستگاه شما یک دستگاه Cams یا دستگاه تأییدشده نیست، تصمیم بعدی این است که دروازه در عمل چگونه با سختافزار شما ارتباط برقرار کند. سه روش ارتباطی در دسترس است و هر کدام الزامات متفاوتی دارند و پیامدهای متفاوتی برای قابلیتهای API که میتوانید استفاده کنید، دارند.
روش ارتباطی به پیکربندی شبکه شما مربوط نمیشود. بلکه به مکانیزم فنیای مربوط میشود که دروازه برای خواندن داده از دستگاه خاص شما و ارسال دستور به آن استفاده میکند. این انتخاب به پشتیبانی سختافزار شما محدود است.
a
Device SDK
بهترین گزینه برای دسترسی کامل به API
دروازه با استفاده از SDK تولیدکننده دستگاه با سختافزار ارتباط برقرار میکند. SDK پروتکل سطح پایین دستگاه را مدیریت میکند و دروازه تمام قابلیتهایی را که SDK پشتیبانی میکند، از طریق API خود در دسترس قرار میدهد. این تنها روش ارتباطی در Hybrid Push است که عملیات RESTful API را فعال میکند.
Callback API کامل + RESTful API کامل (در محدوده قابلیتهای SDK)
b
DB Pull
فقط دادههای حضور و غیاب
دروازه از یک پایگاه داده محلی میخواند که نرمافزار مدیریت خود دستگاه، سوابق حضور و غیاب را در آن مینویسد. دروازه این پایگاه داده را پایش میکند و سوابق جدید را به صورت لحظهای به URL فراخوانی شما ارسال میکند. هیچ ارتباط مستقیمی با دستگاه برقرار نمیشود، یعنی هیچ دستوری نمیتواند به دستگاه ارسال شود. عملیاتی مانند افزودن کاربر، حذف سوابق یا بارگذاری گزارشها در دسترس نیستند.
Callback API: فقط حضور و غیاب و گزارشهای ثبت ساعت. RESTful API: پشتیبانی نمیشود.
c
File Processing
فقط دادههای حضور و غیاب
یک فایل حضور و غیاب مشخص روی رایانه محلی بهطور مداوم پایش میشود. هر بار که نرمافزار دستگاه این فایل را با سوابق جدید حضور و غیاب بهروزرسانی میکند، دروازه تغییر را تشخیص میدهد، سوابق جدید را استخراج میکند و آنها را به صورت لحظهای به URL فراخوانی شما ارسال میکند. این روش مانند DB Pull از دید دستگاه فقط خواندنی است و همان محدودیتهای API را دارد.
Callback API: فقط حضور و غیاب و گزارشهای ثبت ساعت. RESTful API: پشتیبانی نمیشود.
نحوه انتخاب روش ارتباطی
اگر دستگاه شما SDK تولیدکنندهای دارد که توسط دروازه Cams پشتیبانی میشود، Device SDK (a) را انتخاب کنید. این تنها روشی است که عملیات RESTful API را برای دستگاههای Hybrid Push باز میکند. اگر SDK پشتیبانی نشود یا در دسترس نباشد، DB Pull (b) یا File Processing (c) همچنان دادههای حضور و غیاب را بهصورت لحظهای به نقطه پایانی فراخوانی شما ارسال میکنند که برای بسیاری از موارد استفاده کافی است.
آشنایی با Hybrid Push: دو توپولوژی استقرار
پس از انتخاب روش ارتباطی، تصمیم دوم این است که دروازه به دستگاه، پایگاه داده یا فایل شما در کجا متصل شود. این تصمیم توپولوژی است و به محیط شبکه شما در محل فیزیکی دستگاه بستگی دارد.
توپولوژی X
مستقیم
رایانه محل استقرار که دستگاه به آن متصل است، یا جایی که نرمافزار مدیریت دستگاه روی آن اجرا میشود، دارای یک آدرس IP عمومی است و port forwarding به شبکه محلی پیکربندی شده است. دروازه بیومتریک بهطور مستقیم و از طریق اینترنت به دستگاه، پایگاه داده یا فایلها متصل میشود.
الزام: IP عمومی + port forwarding در محل استقرار
توپولوژی Y
غیرمستقیم
یک برنامه Hybrid Connector روی رایانه محل استقرار نصب میشود. این برنامه بهعنوان یک پل خروجی بین دستگاه محلی و دروازه بیومتریک عمل میکند و اتصال را از داخل برقرار میکند، به جای اینکه به یک اتصال ورودی نیاز داشته باشد. در سمت مشتری به IP عمومی نیازی نیست.
الزام: نصب Hybrid Connector روی رایانه محلی. نیازی به IP عمومی نیست.
توصیه درباره توپولوژی
اگر نمیتوانید IP عمومی یا port forwarding را در محل استقرار پیکربندی کنید، توپولوژی غیرمستقیم (Y) را همراه با Hybrid Connector انتخاب کنید. این سادهترین مسیر استقرار است و کاملاً از پیکربندی شبکه در سمت مشتری جلوگیری میکند. اگر IP عمومی در دسترس و پیکربندیشده باشد، توپولوژی مستقیم (X) نیز کار میکند و نیازی به نصب نرمافزار اضافی در محل استقرار ندارد.
درخت تصمیم: کدام حالت را باید انتخاب کنید؟
این درخت تصمیم را از بالا به پایین دنبال کنید. در اولین پاسخی که با وضعیت شما مطابقت دارد، توقف کنید.
درخت تصمیم، از بالا شروع کنید
۱. آیا دستگاه شما یک دستگاه Cams Biometrics است، یا در developer.camsbiometrics.com بهعنوان دستگاه تأییدشده فهرست شده است؟
بله از Native Push استفاده کنید. دسترسی کامل به API. نیازی به تصمیمگیری بیشتر نیست.
خیر به پرسش ۲ ادامه دهید.
۲. آیا دروازه Cams از SDK تولیدکننده دستگاه شما پشتیبانی میکند؟
بله از Hybrid Push، Device SDK (a) استفاده کنید. دسترسی کامل Callback و RESTful API در محدوده SDK. برای توپولوژی به پرسش ۳ ادامه دهید.
خیر به پرسش ۲ب ادامه دهید.
۲ب. آیا نرمافزار مدیریت دستگاه شما سوابق حضور و غیاب را در یک پایگاه داده محلی مینویسد؟
بله از Hybrid Push، DB Pull (b) استفاده کنید. فقط Callback حضور و غیاب. برای توپولوژی به پرسش ۳ ادامه دهید.
۳. آیا رایانه محل استقرار دارای آدرس IP عمومی با port forwarding در دسترس است؟
بله از توپولوژی مستقیم (X) استفاده کنید. در محل استقرار به نرمافزار اضافی نیازی نیست.
خیر از توپولوژی غیرمستقیم (Y) استفاده کنید. Hybrid Connector را روی رایانه محل استقرار نصب کنید.
ماتریس در دسترس بودن قابلیتهای Hybrid Push
جدول زیر هر ترکیب ممکن از روش ارتباطی و توپولوژی استقرار را نشان میدهد و مشخص میکند که در هر حالت کدام قابلیتهای API در دسترس هستند. از این جدول همراه با درخت تصمیم استفاده کنید تا مطمئن شوید پیکربندی انتخابی شما از چه قابلیتهایی پشتیبانی میکند.
| حالت |
ارتباط |
توپولوژی |
Callback API |
RESTful API |
| دستگاه مستقیم |
(a) Device SDK |
(X) IP عمومی |
کامل |
کامل (محدودیتهای SDK اعمال میشود) |
| دستگاه غیرمستقیم |
(a) Device SDK |
(Y) Hybrid Connector |
کامل |
کامل (محدودیتهای SDK اعمال میشود) |
| پایگاه داده مستقیم |
(b) DB Pull |
(X) IP عمومی |
فقط حضور و غیاب |
پشتیبانی نمیشود |
| پایگاه داده غیرمستقیم |
(b) DB Pull |
(Y) Hybrid Connector |
فقط حضور و غیاب |
پشتیبانی نمیشود |
| فایل مستقیم |
(c) File Processing |
(X) IP عمومی |
فقط حضور و غیاب |
پشتیبانی نمیشود |
| فایل غیرمستقیم |
(c) File Processing |
(Y) Hybrid Connector |
فقط حضور و غیاب |
پشتیبانی نمیشود |
هشدار مهم درباره سختافزار
محدودیتهای سختافزاری میتوانند قابلیتهای API را حتی در حالت Device SDK بیشتر محدود کنند. ممکن است برخی APIها بسته به نسخه فریمور مدل دستگاه یا قابلیتهای ارائهشده توسط SDK تولیدکننده، کار نکنند. ماتریس بالا آنچه را که معماری دروازه پشتیبانی میکند توصیف میکند، نه آنچه که تضمین شده است هر مدل دستگاه پشتیبانی کند. همیشه با سختافزار مشخص خود آزمایش کنید و پیش از استقرار در محیط واقعی، موارد خاص را با تیم پشتیبانی Cams بررسی کنید.
تصمیم توپولوژی چه چیزی را تحت تأثیر قرار میدهد و چه چیزی را نه
یک سردرگمی رایج، رابطه بین توپولوژی و در دسترس بودن API است. انتخاب توپولوژی، چه مستقیم و چه غیرمستقیم، تأثیری بر اینکه کدام قابلیتهای API در دسترس هستند ندارد. مجموعه قابلیتهای API کاملاً توسط روش ارتباطی تعیین میشود.
آنچه توپولوژی تحت تأثیر قرار میدهد، نحوه برقراری اتصال شبکه بین دروازه و محیط محلی شما است. توپولوژی مستقیم به IP عمومی و port forwarding در محل استقرار نیاز دارد. توپولوژی غیرمستقیم نیازمند نصب Hybrid Connector روی دستگاه محلی است. قابلیتهای API در دسترس شما برای Direct Device SDK و Indirect Device SDK یکسان است و همچنین برای Direct DB Pull و Indirect DB Pull نیز یکسان است.
“روش ارتباطی خود را بر اساس قابلیتهای API که یکپارچهسازی شما به آنها نیاز دارد انتخاب کنید. توپولوژی خود را بر اساس آنچه محیط شبکه شما پشتیبانی میکند انتخاب کنید. اینها تصمیمهای مستقل از هم هستند.”
پرسشهای متداول
آیا میتوانم DB Pull یا File Processing را همراه با دستورات RESTful API استفاده کنم؟
خیر. DB Pull و File Processing روشهای یکپارچهسازی فقط خواندنی هستند. این روشها به دروازه اجازه میدهند دادههای حضور و غیابی را که توسط نرمافزار خود دستگاه تولید میشود مشاهده کند، اما کانالی ایجاد نمیکنند که از طریق آن دستوری به دستگاه ارسال شود. عملیات RESTful API مانند افزودن کاربر، حذف سوابق یا بارگذاری گزارشها نیازمند حالت Device SDK هستند که یک کانال ارتباطی دوطرفه ایجاد میکند.
آیا Hybrid Connector باید روی همان رایانهای نصب شود که نرمافزار دستگاه روی آن است؟
بله. Hybrid Connector باید روی همان رایانه محلی نصب شود که دستگاه به آن متصل است یا نرمافزار مدیریت دستگاه روی آن اجرا میشود. دلیل این امر این است که بسته به روش ارتباطی شما، به دسترسی محلی به دستگاه، پایگاه داده محلی یا فایل حضور و غیاب نیاز دارد. سپس Connector یک تونل خروجی به دروازه ایجاد میکند و نیاز به IP عمومی در آن محل را از بین میبرد.
تفاوت تأخیر بین Native Push و Hybrid Push چقدر است؟
برای Native Push، رویدادهای Callback API بدون تأخیر ارسال میشوند و دستورات RESTful API تقریباً در ۳۰ ثانیه اجرا میشوند. برای Hybrid Push با استفاده از Device SDK، تأخیر به چرخه ارتباطی خود SDK بستگی دارد و بسته به تولیدکننده دستگاه متفاوت است. تأخیر DB Pull و File Processing به میزان دفعات نوشتن رکوردهای جدید توسط نرمافزار محلی و سرعت تشخیص تغییر توسط دروازه بستگی دارد و معمولاً در چند ثانیه پس از ثبت رویداد توسط دستگاه انجام میشود.
نتیجهگیری: حالت خود را با محدودیتهایتان هماهنگ کنید
تصمیم درباره حالت اتصال به دروازه بیومتریک Cams یک پرسش ترجیحی نیست، بلکه یک پرسش مبتنی بر محدودیتهاست. اگر دستگاه شما واجد شرایط باشد، Native Push پاسخ درست است، زیرا بیشترین قابلیت را با کمترین پیکربندی فراهم میکند. Hybrid Push پاسخ همه موارد دیگر است و در داخل آن، حالت Device SDK نزدیکترین معادل Native Push را از نظر دسترسی به API به شما میدهد.
وقتی دسترسی کامل به SDK در دسترس نباشد، DB Pull و File Processing مسیرهای عملیای هستند که همچنان دادههای حضور و غیاب را بهصورت لحظهای به سیستمهای شما ارسال میکنند. در این صورت، تصمیم توپولوژی یک انتخاب جداگانه و در سطح زیرساخت است که آنچه API میتواند انجام دهد را تغییر نمیدهد.
با درخت تصمیم شروع کنید، انتخاب خود را با ماتریس قابلیتها بررسی کنید، با سختافزار خود آزمایش کنید و پیش از ورود به محیط واقعی، موارد خاص را با تیم پشتیبانی Cams تأیید کنید.