الرئيسية / مرجع API

Biometric Gateway API

عقد واحد لكل الأجهزة. 38 عملية في خمس مجموعات من الإمكانات، متاحة كاستدعاءات REST متزامنة وwebhooks Callback في الوقت الفعلي.

🌐

Base URL

تُنفَّذ جميع استدعاءات REST على مضيف واحد ذي إصدار محدد.

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

🔑

المصادقة

يحمل كل طلب AuthToken مقيّدًا بحسابك وجهازك. تُصدَر المفاتيح من بوابة المطورين.

📦

الصيغة

طلبات بترميز النماذج أو JSON. الاستجابات بصيغة JSON بحقول ورموز أخطاء يمكن التنبؤ بها.

طريقتان للتكامل

REST حين تطلب. Callback حين يحدث الأمر.

REST

طلب / استجابة

تستدعي البوابة وتحصل على إجابة فورية. مثالي لجلب الحضور وعرض المستخدمين وتسجيل شخص أو فتح باب عند الطلب.

  • متزامن ويمكن التنبؤ به
  • ممتاز للمزامنات والتقارير والإجراءات الإدارية
  • يعمل من أي لغة أو من cURL
CALLBACK

webhooks في الوقت الفعلي

سجّل عنوان URL فتدفع إليك البوابة الأحداث لحظة إبلاغ الجهاز بها — دون استعلام دوري، مع إعادة محاولة تلقائية عند الفشل.

  • أحداث حضور وحالة فورية
  • دون مهام cron ودون بصمات حضور مفقودة
  • إعادة المحاولة إلى أن تؤكد نقطة النهاية (endpoint) لديك الاستلام

العمليات

جميع العمليات الـ 38

مجمّعة بحسب وظيفتها. تطابق الأسماء نقاط نهاية البوابة الأساسية 1:1.

📊

الحضور · 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 لـ webhook لتلقي الأحداث المباشرة.

PUSH
attendance.new

يُطلَق مع كل بصمة حضور في الوقت الفعلي.

PUSH
device.status

انتقالات الاتصال / عدم الاتصال والحالة الصحية.

PUSH
enrollment.update

تأكيد عند وصول قالب إلى الجهاز.

GET
MigrationStatus

تتبّع تقدّم الترحيل المجمّع للأجهزة / البيانات.

استجابات يمكن التنبؤ بها

رموز حالة يمكنك بناء المنطق عليها

الرمزالمعنىماذا تفعل
200نجاحعالج حمولة JSON.
401AuthToken غير صالح أو مفقودتحقق من مفتاح API وإقران الجهاز.
404الجهاز أو المستخدم غير موجودتحقق من الرقم التسلسلي / رمز الموظف.
409الجهاز غير متصل / في قائمة الانتظارالأمر في قائمة الانتظار؛ استعلم عن GetCommandStatus دوريًا.
429تجاوز حد المعدّلتمهّل وأعد المحاولة مع تأخير عشوائي (jitter).

هل أنت مستعد لاستدعاء أول endpoint؟

يرشدك دليل البدء السريع من مفتاح API إلى أول سجل حضور خلال دقائق.