REST / HTTPS
أسلوب API موحد للسحابة والبوابة المحلية؛ تبادل بيانات JSON
توفر منصة مطوري بيوربوينت سمارت واجهة RESTful API موحدة ومفتوحة SDK للمتكاملين وبائعي PMS/CRS ومزودي البرامج المستقلين — وتغطي تأهيل الأجهزة وحالة الغرفة والتحكم في المشاهد وبيانات الطاقة واشتراكات الأحداث. عبر السحابة أو البوابة المحلية، ادمج تحكم غرف الضيوف من بيوربوينت سمارت في عمليات الفندق وأنظمة إدارة المباني بسرعة.
قدرات المنصة
-
RESTful API
طلب/استجابة JSON عبر HTTPS, ومسارات ذات إصدارات — تكامل سهل للواجهة الأمامية والخلفية وأنظمة الطرف الثالث.
-
SDK متعدد اللغات
عينات Java و Python و Node.js بالإضافة إلى أدوات التوقيع لتقصير دورات التكامل والإطلاق.
-
أحداث Webhook
دفع تغييرات حالة الغرفة والتنبيهات ونتائج المشاهد بشكل استباقي — مع إعادة المحاولة والتحقق من التوقيع.
-
بيئة تجريبية
مستأجر اختبار مخصص وأجهزة محاكاة لتكامل ما قبل الإنتاج والتحقق من الحمل (يُفعّل بطلب).
وحدات API
واجهات مجمعة حسب مجال الأعمال مع صلاحيات محددة؛ تعريفات الحقول وحدود المعدل وفق الوثائق الرسمية.
-
الأجهزة والنقاط
استعلام حالة RCU واللوحات والمستشعرات؛ قراءة/كتابة قيم النقاط والإدخال/الإخراج الرقمي والتناظري.
-
الغرف والحالة
مزامنة تسجيل الدخول/الخروج و DND و MUR و SOS وحالات الغرفة الأخرى؛ ربط بأرقام غرف PMS.
-
المشاهد والربط
تشغيل الترحيب وقطع الشغور ووضع الاجتماع وغيرها؛ استعلام النتائج وأسباب الفشل.
-
الطاقة والتقارير
تجميع بيانات الطاقة و HVAC حسب الغرفة أو الطابق أو المنطقة العامة؛ واجهات تصدير التقارير.
-
التنبيهات والتشغيل
الاشتراك في انقطاع الأجهزة وأعطال الاتصال وتنبيهات الحمل؛ التكامل مع أنظمة التذاكر.
-
المشاريع والوصول
عزل المستأجرين متعدد الفنادق/المشاريع؛ إدارة AppKey والأدوار ونطاق API.
بدء سريع
-
تسجيل حساب مطور
أرسل طلب تكامل عبر المبيعات أو الدعم للحصول على AppKey / AppSecret.
-
إعداد عنوان الاستدعاء
سجّل عنوان Webhook في وحدة تحكم المطورين لأحداث حالة الغرفة والتنبيهات.
-
تكامل بيئة تجريبية
استدعِ واجهات API بمعرّف مشروع اختبار للتحقق من التوقيع والمصادقة وحقول الأعمال.
-
الإطلاق في الإنتاج
بعد القبول، انتقل إلى بيانات اعتماد الإنتاج وراقب حجم الاستدعاءات ومعدلات الأخطاء وفق SLA.
نقاط نهاية شائعة
أمثلة مسارات REST نموذجية؛ حمّل مواصفات OpenAPI الكاملة من مركز التنزيل.
| الطريقة | المسار | الوصف |
|---|---|---|
| POST | /v1/oauth/token | الحصول على رمز وصول (Client Credentials) |
| GET | /v1/projects/{id}/rooms | قائمة غرف مقسمة مع ملخص الحالة |
| GET | /v1/projects/{id}/rooms/{roomNo}/devices | أجهزة الغرفة وحالة الاتصال |
| PUT | /v1/projects/{id}/rooms/{roomNo}/scene/{sceneId} | تشغيل مشهد (مثل الترحيب أو قطع الشغور) |
| POST | /v1/projects/{id}/rooms/{roomNo}/points | كتابة دفعية للنقاط (مفاتيح، تعتيم، نقاط ضبط HVAC, إلخ) |
| GET | /v1/projects/{id}/energy/summary | ملخص الطاقة لفترة زمنية |
| POST | /v1/webhooks/subscriptions | تسجيل اشتراك Webhook (حالة الغرفة، تنبيهات، إلخ) |
البروتوكولات والنظام البيئي
إلى جانب HTTP API, تُدعم الحافلات الميدانية ومنصات الطرف الثالث لتكامل متنوع بين الفنادق والمباني.
BACnet / Modbus
تحويل بروتوكول لـ BMS و HVAC والقياس وأنظمة فرعية أخرى
MQTT
إبلاغ الأجهزة وتوصيل الأوامر في سيناريوهات النطاق الترددي المنخفض
KNX / إضافات النظام البيئي
يعمل مع KNX و Home Assistant وحلول ربط أخرى
عملية الانضمام
إرسال الطلب
صف سيناريو التكامل وحجم الاستدعاء المتوقع وجدول الإطلاق
إصدار بيانات الاعتماد
تعيين مفاتيح بيئة تجريبية وإنتاج
اختبار التكامل
يساعد الدعم الفني في اختبار API و Webhook
الإطلاق
الانتقال إلى الإنتاج وإدراجه في مراقبة التشغيل
الأسئلة الشائعة
كيف أحصل على مفاتيح API?
متاح للمتكاملين المتعاقدين والعملاء الاستراتيجيين. أرسل ملخص التكامل عبر المبيعات أو الدعم؛ بعد الموافقة، أنشئ تطبيقًا في وحدة تحكم المطورين للحصول على AppKey و AppSecret.
هل يُدعم نشر البوابة المحلية؟
نعم. يمكن لمجموعات الفنادق الكبرى استخدام بوابات طرفية محلية مع API متسق مع السحابة في سيناريوهات عدم الاتصال وزمن الاستجابة المنخفض؛ يُحدد التصميم لكل مشروع.
هل توجد حدود للمعدل؟
تُطبق حدود QPS والحصص اليومية الافتراضية لكل تطبيق؛ يمكن للمشاريع الكبيرة طلب زيادة. تجاوز الحدود يُرجع 429 — نفّذ تراجعًا أسيًا.
كيف يتم تأمين Webhooks?
تتضمن حمولات الأحداث توقيع HMAC والطابع الزمني؛ تحقق من التوقيع وارفض الطلبات القديمة. استخدم نقاط نهاية HTTPS; قوائم IP المسموح بها متاحة عند الطلب.
ما الفرق عن منصة السحابة؟
منصة السحابة للتشغيل المرئي للموظفين؛ واجهة API للمطورين للتكامل والأتمتة — PMS و CRM ومنصات الطاقة، إلخ. يمكن استخدامهما معًا.
هل تحتاج تدريبًا في الموقع أو دعم ما بعد البيع؟
نقدم تدريب تكامل API وتوجيه قبول المشاريع ودعمًا فنيًا طوال دورة الحياة.
