مقدمة

هذه هي API الأساسية المستخدمة للمواقع والأنظمة العامة. **إذا كنت مطوّرًا من جهة خارجية وترغب في استخدام هذه API، فيُرجى التواصل مع دعم Performance Hub لإضافة عناوين IP الخاصة بك إلى قائمة السماح، وإلا فسيتم تقييد معدل طلباتك و/أو حظرك إذا كثرت الطلبات من المُحيل / عنوان IP نفسه.**

عنوان URL الأساسي

https://uapi.gymsystems.co/

المصادقة

تستخدم Universal API المصادقة بمفتاح API عبر ترويسات HTTP.

أدرج مفتاح API الخاص بك في الترويسة X-API-Key مع كل طلب.

تعامل مع مفاتيح API بحذر، فهي تمنح وصولًا كاملًا إلى حسابك! لا تكشف هذه المفاتيح أبدًا في المستودعات العامة أو التطبيقات من جانب العميل أو في أي مكان قد تتعرض فيه للاختراق.

لا تقبل API إلا اتصالات HTTPS الآمنة. تُرفض طلبات HTTP العادية، وكذلك أي طلبات تفتقر إلى بيانات اعتماد المصادقة الصحيحة.

مثال على الطلب

curl https://uapi.gymsystems.co/api/v1/clubs \
  -H "X-API-Key: YOUR_API_KEY"

نموذج التواصل العام

API المستخدمة لرسائل 'التواصل العام' من مواقع Example Club الإلكترونية والخدمات الخارجية الأخرى (مثل المعسكر التدريبي وغيرها).

المعلمات

organisationId `string` (اختياري) معرّف المنظمة التي تريد الحصول على بيانات منشآتها، ويُستخدم لضمان عدم إرجاع إلا المنشآت التابعة للمنظمة نفسها. leadForwarding `string` (اختياري) هل يجب إعادة توجيه رسائل البريد الإلكتروني إلى أي نظام لإدارة العملاء المحتملين (gymsales وgymleads وغيرهما)؟ ملاحظة: يؤدي الضبط على `onlyForwardIfConfigured` إلى إعادة توجيه العملاء المحتملين إلى أي نظام CRM، لكن ليس إلى البريد الإلكتروني الأساسي للمنشأة...

نص الطلب

نص نموذج التواصل العام

نقطة النهاية

POST /api/v1/support/contact-submission

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/support/contact-submission \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

التجربة المجانية

ينشئ طلب صفحة هبوط 'تجربة مجانية' للمنشأة المحددة

نص الطلب

نص طلب التجربة المجانية

نقطة النهاية

POST /api/v1/leads/free-trial

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/leads/free-trial \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

حجز تمرين

API المستخدمة لنموذج 'حجز تمرين' في مواقع Example Club الإلكترونية.

نص الطلب

نص طلب حجز تمرين

نقطة النهاية

POST /api/v1/leads/book-a-workout

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/leads/book-a-workout \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

طلبات تسجيل الاهتمام بالمعسكر التدريبي

يتتبع طلبات تسجيل اهتمام المستخدم بالمعسكر التدريبي من مواقعنا الإلكترونية الرئيسية، وتُستخدم هذه المعلومات بعد ذلك لإحالة المستخدم إلى تطبيق/موقع trainingcamp.com ولكي تتمكن المنشآت من تسجيل العضو في المعسكر التدريبي.

نص الطلب

نص الصفحة

نقطة النهاية

POST /api/v1/leads/training-camp

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/leads/training-camp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يحصل على البيانات الوصفية لمنشأة واحدة أو لجميع المنشآت

تعيد هذه API إما البيانات الوصفية المستخدمة لعرض صفحة منشأة واحدة، أو جميع المنشآت في قاعدة البيانات.

المعلمات

organisationId `string` (اختياري) معرّف المنظمة التي تريد الحصول على بيانات منشآتها، ويُستخدم لضمان عدم إرجاع إلا المنشآت التابعة للمنظمة نفسها. club `string` (اختياري) معرّف المنشأة التي تريد الحصول عليها... *ملاحظة* يمكنك حذفه إذا كنت تريد إرجاع جميع المنشآت ككائن JSON واحد.

نقطة النهاية

GET /api/v1/club/data

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/club/data \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

يحصل على البيانات الوصفية لمنشأة واحدة أو لجميع المنشآت

تعيد هذه API إما البيانات الوصفية المستخدمة لعرض صفحة منشأة واحدة، أو جميع المنشآت في قاعدة البيانات.

المعلمات

نقطة النهاية

GET /api/v2/club/data

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v2/club/data \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

البحث عن المنشآت حسب المدينة وخطَّي العرض والطول

إجراء بحث عن المنشآت القريبة، بناءً على خط العرض وخط الطول وعبارات البحث (مثل الضاحية أو البلدة أو المدينة)

المعلمات

geogroup `string` (اختياري) يعيد قائمة 'مجمّعة' بالمدن/الولايات/البلدان التي توجد فيها المنشآت search `string` (اختياري) العبارة المراد البحث عنها، وتكون عمومًا إحدى ما يلي: بلدة أو مدينة أو ضاحية أو رمز بريدي limit `string` (اختياري) الحد الأقصى لعدد النتائج origin `string` (اختياري) خط العرض وخط الطول اللذان يستند إليهما البحث، وهذا ضروري عند البحث عن بلدات/ضواحٍ تحمل الاسم نفسه ولكن في بلدان/مدن مختلفة لدينا فيها عدة منشآت، مثل `Southbank Example City` أو `Southbank Example City 2` organisationId `string` (اختياري) معرّف المنظمة المراد تصفية المنشآت حسبه، ويُستخدم لضمان عدم إرجاع إلا المنشآت التابعة للمنظمة نفسها.

نقطة النهاية

GET /api/v1/club/geosearch

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/club/geosearch \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

يسرد المراجعات المثبتة لمنشأة واحدة

تعيد هذه API المراجعات المثبتة للمنشأة.

المعلمات

club `string` (اختياري) معرّف المنشأة التي تريد الحصول عليها

نقطة النهاية

GET /api/v2/club/reviews

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v2/club/reviews \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد إعدادات تطبيق مضبوط في المنشأة المحددة

المعلمات

clubID `string` (اختياري) معرّف المنشأة التي تريد الحصول عليها appID `string` (اختياري) معرّف التطبيق الذي تريد الحصول عليه

نقطة النهاية

GET /api/v1/club/apps/config

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/club/apps/config \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

خط العرض وخط الطول بناءً على عنوان IP للمستخدم

يعيد خط العرض وخط الطول التقديريين لعنوان IP للمستخدم بناءً على قاعدة بيانات GeoIP من Maxmind.

نقطة النهاية

GET /api/v1/geo/ip

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/geo/ip \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

يحلّل سلسلة عنوان ويعيدها ككائن.

تحويل سلسلة العنوان إلى كائن يتكون من الشارع والمدينة والولاية والرمز البريدي.

نص الطلب

نص الصفحة

نقطة النهاية

POST /api/v1/user/address-parser

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/user/address-parser \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يتتبع عناوين البريد الإلكتروني المرسلة في قاعدة بياناتنا المركزية.

تتبع عناوين البريد الإلكتروني المرسلة إلى أجزاء مختلفة من موقعنا الإلكتروني _(مثل واجهات API الداخلية وMailchimp وHubspot وغيرها)_ و/أو واجهات API لجهات خارجية في جدول DynamoDB المركزي لدينا، مما يتيح لنا إجراء تحليل واستهداف أكثر تفصيلًا للأعضاء من منظومة Example Club.

نص الطلب

نص الصفحة

نقطة النهاية

POST /api/v1/analytics/track-email

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/track-email \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

إرسال البيانات إلى Graylog

يرسل البيانات من خدمات الواجهة الأمامية المختلفة إلى نظام إدارة السجلات الداخلي لدينا (Graylog).

نص الطلب

نص الصفحة

نقطة النهاية

POST /api/v1/analytics/beacon

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

التحقق مما إذا كان معرّف حزام Myzone مسجلًا لدى منشأة

يعيد استجابة true أو false بحسب ما إذا كان معرّف حزام Myzone مرتبطًا بمعرّف المنشأة المحدد.

المعلمات

club `string` (اختياري) معرّف المنشأة المراد الاستعلام عنها beltid `string` (اختياري) معرّف حزام Myzone المراد البحث عنه

نقطة النهاية

GET /api/v1/myzone/belt-registered

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/myzone/belt-registered \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد تكرار تمريرات بطاقات الزيارة

استرداد قائمة تمريرات بطاقات الزيارة التي أجراها الأعضاء خلال فترة معيّنة

المعلمات

start_date `string` (اختياري) تاريخ بداية الفترة المستخدم لتصفية زيارات الأعضاء end_date `string` (اختياري) تاريخ نهاية الفترة المستخدم لتصفية زيارات الأعضاء club `string` (اختياري) المنشأة المحددة المشترك فيها العضو، لتصفية المنشأة التي مرّر فيها العضو بطاقته email `string` (اختياري) البريد الإلكتروني المحدد المستخدم في تمرير بطاقة الزيارة

نقطة النهاية

GET /api/v1/members/swipes/frequency

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/members/swipes/frequency \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

خطاف ويب لأحداث تسجيل الحضور في GymMaster

نقطة النهاية

POST /api/v1/webhooks/gymmaster/checkin

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/webhooks/gymmaster/checkin \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تسجيل/إرسال معرّف الجهاز

يخزّن UUID وعنوان IP ومعرّف الشاشة (معرّف الجهاز) لحاسوب Display Screen في قاعدة البيانات، مما يتيح ربط الجهاز عبر Performance Hub.

نص الطلب

يجب إرسال كائن JSON إلى نقطة النهاية هذه يحتوي على معلومات عن الجهاز، مثل عنوان IP وUUID

نقطة النهاية

POST /api/v1/devices/dashkiosk/register

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/dashkiosk/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يضبط حالة زر الاستغاثة

يضبط حالة زر الاستغاثة المرتبط بمنشأة على `true|false`. ملاحظة: لا يمكنك تغيير الحالة إلا لزر مسجّل لدى منشأة، ولن يعمل ذلك مع الأجهزة التي لم يتم إعدادها بعد.

نص الطلب

كائن JSON لحالة إنذار زر الاستغاثة

نقطة النهاية

POST /api/v1/devices/duress/setAlarmState

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/duress/setAlarmState \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يعيد أزرار الاستغاثة المرتبطة بالمنشأة

يعيد مصفوفة بأزرار الاستغاثة المرتبطة بمنشأة لفحص التحديثات منها.

المعلمات

clubID `string` (مطلوب) معرّف المنشأة المراد الاستعلام عنها

نقطة النهاية

GET /api/v1/devices/duress/getDuressButtons/{clubID}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/devices/duress/getDuressButtons/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

يحدّث البيانات الوصفية للجهاز

يحدّث البيانات الوصفية للجهاز لـ UUID معيّن. ملاحظة: لا تلزم مصادقة لإرسال البيانات إلى هذه الدالة، لذا يجب ألا تحتوي البيانات على أي معلومات حساسة.

نص الطلب

يجب إرسال كائن JSON إلى نقطة النهاية هذه يحتوي على معلومات عن الجهاز، مثل معلومات نظام التشغيل ومقاييس Wi-Fi وغيرها...

نقطة النهاية

POST /api/v1/devices/metadata/beacon

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/metadata/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يعيد معلومات عن شاشة بناءً على UUID الجهاز.

يحصل على إعدادات جهاز بناءً على UUID الجهاز، ويعيد معلومات مثل الجولة المرتبطة بالجهاز والمحتوى الذي يجب عرضه.

المعلمات

uuid `string` (مطلوب) UUID الجهاز الذي تُجلب إعداداته

نقطة النهاية

GET /api/v1/devices/displayconfig/{uuid}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/devices/displayconfig/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

يعيد معلومات إعدادات جهاز بناءً على UUID.

يجلب إعدادات جهاز من عدة جداول (Display Screens، وأجهزة IoT، وأجهزة CCTV) باستخدام UUID الجهاز، ويعيد تفاصيل الإعدادات ذات الصلة بتنسيق JSON.

المعلمات

uuid `string` (مطلوب) UUID الجهاز المراد جلب إعداداته

نقطة النهاية

GET /api/v1/devices/config/{uuid}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/devices/config/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تسجيل جهاز إشارة BLE

يحفظ معلومات جهاز إشارة BLE في قاعدة بياناتنا

نص الطلب

بيانات جهاز إشارة BLE

نقطة النهاية

POST /api/v1/devices/blebeacon/register

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/blebeacon/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يسرد أجهزة CCTV المرتبطة بـ ClubID

يسرد التفاصيل العامة لأجهزة CCTV المرتبطة بـ ClubID. ملاحظة: لا تُعاد عبر هذه API إلا المعلومات العامة مثل عناوين IP المحلية للأجهزة وما إذا كانت متصلة أو غير متصلة. يجب استخدام Performance Hub API للحصول على تفاصيل الأجهزة المتقدمة.

المعلمات

clubID `string` (مطلوب) معرّف المنشأة المراد الاستعلام عنها

نقطة النهاية

GET /api/v1/devices/cctv/list-devices/{clubID}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/devices/cctv/list-devices/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تسجيل جهاز CCTV

يحفظ معلومات جهاز CCTV في قاعدة بياناتنا

نص الطلب

بيانات جهاز CCTV

نقطة النهاية

POST /api/v1/devices/cctv/register

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

تسجيل جهاز AI Edge Processor

يحفظ معلومات جهاز AI Edge Processor في قاعدة بياناتنا

نص الطلب

بيانات جهاز AI Edge Processor

نقطة النهاية

POST /api/v1/devices/ai-edge-processor/register

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/ai-edge-processor/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

ينشئ عنوان URL موقّعًا لقبول رفع تسجيلات CCTV

ينشئ عنوان URL موقّعًا لـ S3 للسماح للعميل برفع تسجيل CCTV مباشرةً إلى S3 للمعالجة اللاحقة.

نص الطلب

البيانات الوصفية للجهاز

نقطة النهاية

POST /api/v1/devices/cctv/generate-upload-token

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/generate-upload-token \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

يُبلغ S3 باكتمال الرفع متعدد الأجزاء

يُبلغ S3 بأن العميل أكمل الرفع متعدد الأجزاء

نص الطلب

البيانات الوصفية للجهاز

نقطة النهاية

POST /api/v1/devices/cctv/complete-upload

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/complete-upload \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

الاستجابة

{}

إرسال أمر Sonos إلى أجهزة Sonos في المنشأة

المعلمات

clubID `string` (مطلوب) معرّف المنشأة المراد الاستعلام عنها

نقطة النهاية

POST /api/v1/devices/audio-control/command/{clubID}

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/devices/audio-control/command/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد إعدادات التحكم في الصوت للمنشأة

المعلمات

clubID `string` (مطلوب) معرّف المنشأة المراد الاستعلام عنها

نقطة النهاية

GET /api/v1/devices/audio-control/config/{clubID}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/devices/audio-control/config/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

إنشاء رمز وصول مؤقت

نقطة النهاية

POST /api/v1/temporary-access/token

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/temporary-access/token \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد عناصر البث المباشر للموسيقى

نقطة النهاية

GET /api/v1/streams

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/streams \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد بيانات عنصر البث المباشر للموسيقى

المعلمات

id `string` (مطلوب) معرّف فريد يحدد عنصر البث

نقطة النهاية

GET /api/v1/streams/{id}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/streams/{id} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد عناصر الأسئلة الشائعة

المعلمات

location `string` (اختياري) الموقع الذي تريد أن يظهر فيه عنصر الأسئلة الشائعة، مثل الموقع الإلكتروني الرئيسي (website_main). categories `string` (اختياري) فئات عنصر الأسئلة الشائعة. status `string` (اختياري) حالة العنصر

نقطة النهاية

GET /api/v1/faqs

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/faqs \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد عناصر الأسئلة الشائعة

المعلمات

category `string` (مطلوب) عامل تصفية الفئات

نقطة النهاية

GET /api/v1/faqs/{category}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/faqs/{category} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد العناصر الصحفية

المعلمات

location `string` (اختياري) الموقع الذي تريد أن يظهر فيه العنصر الصحفي، مثل الموقع الإلكتروني الرئيسي (website_main). status `string` (اختياري) حالة العنصر

نقطة النهاية

GET /api/v1/press

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/press \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد تعيين البريد الإلكتروني

نقطة النهاية

GET /api/v1/email-mapping

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/email-mapping \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد رموز التتبع المخصصة

المعلمات

clubID `string` (مطلوب) معرّف المنشأة أو موقعها، مثل Milton

نقطة النهاية

GET /api/v1/customtracking/{clubID}

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/customtracking/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

استرداد عناصر صفحات الهبوط

المعلمات

region `string` (اختياري) المنطقة التي تنتمي إليها المنشأة، مثل AU وNZ وUS club `string` (اختياري) معرّف المنشأة (Club ID)، وهو المعرّف الفريد للمنشأة slug `string` (اختياري) الجزء الأخير من عنوان URL الذي يعمل كمعرّف فريد للصفحة

نقطة النهاية

GET /api/v1/landing-pages

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/landing-pages \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

نموذج التواصل في موقع Performance Hub الإلكتروني

يتلقى النماذج المرسلة من موقع Performance Hub الإلكتروني (طلبات العروض التوضيحية، واستفسارات المبيعات، وطلبات الوصول المبكر) ويرسل رسائل بريد إلكتروني للإشعار عبر SES.

نقطة النهاية

POST /api/v1/performancehub/website-contact

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/performancehub/website-contact \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

طلب رمز OTP لـ Door & Gate Access

يرسل رمز تحقق لمرة واحدة إلى الهاتف أو البريد الإلكتروني المقدَّم. يستجيب دائمًا بـ 200 لمنع تعداد المعرّفات. معدل الطلبات محدود لكل معرّف ولكل عنوان IP (نافذة منزلقة في Redis).

نقطة النهاية

POST /api/v1/door-gate-access/auth/otp/request

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/request \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

التحقق من رمز OTP لـ Door & Gate Access وإصدار الرموز

يتحقق من رمز OTP، ويحدد ملفات تعريف الأشخاص المرتبطة عبر جميع المنشآت، ويعيد JWT قصير الأجل + رمز تحديث مبهمًا متجددًا.

نقطة النهاية

POST /api/v1/door-gate-access/auth/otp/verify

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/verify \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تدوير رمز تحديث Door & Gate Access

نقطة النهاية

POST /api/v1/door-gate-access/auth/refresh

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/refresh \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

إلغاء رمز تحديث Door & Gate Access

نقطة النهاية

POST /api/v1/door-gate-access/auth/logout

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/logout \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

جلسة Door & Gate Access الحالية

نقطة النهاية

GET /api/v1/door-gate-access/me

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تحديث حقول الملف الشخصي القابلة للتعديل

يحدّث firstName / lastName في كل صف ph-door-access-users يطابق معرّف JWT. لا يمكن تغيير البريد الإلكتروني والهاتف هنا.

نقطة النهاية

PATCH /api/v1/door-gate-access/me

مثال على الطلب

curl -X PATCH https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

سرد المنشآت لمستخدم Door & Gate Access

نقطة النهاية

GET /api/v1/door-gate-access/me/facilities

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/facilities \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

تعيين المنشأة المحددة حاليًا للمستخدم

نقطة النهاية

POST /api/v1/door-gate-access/me/facility

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/me/facility \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

سرد الأبواب التي يمكن للمستخدم فتحها في منشأة

المعلمات

facilityId `string` (اختياري) معرّف المنشأة (clubID).

نقطة النهاية

GET /api/v1/door-gate-access/me/doors

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/doors \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

محاولات فتح القفل الأخيرة للمستخدم الحالي

نقطة النهاية

GET /api/v1/door-gate-access/me/access-history

مثال على الطلب

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/access-history \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}

فتح قفل باب من تطبيق Door & Gate Access للهاتف المحمول

عمليات تحقق صارمة على الخادم قبل النشر إلى MQTT. الخادم هو المرجع المعتمد للقواعد الدائمة، وAccess Time Windows الإضافية، وحظر الأبواب الصريح، ووضع الصيانة، والسياج الجغرافي. حالة العميل لتجربة المستخدم فقط.

المعلمات

doorId `string` (مطلوب) قيمة balenaUUID لوحدة التحكم بالباب.

نقطة النهاية

POST /api/v1/door-gate-access/doors/{doorId}/unlock

مثال على الطلب

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/doors/{doorId}/unlock \
  -H "x-api-key: YOUR_API_KEY"

الاستجابة

{}