تتيح واجهة برمجة التطبيقات العامة الخاصة بـ Tournament Manager (TM) للمطورين الخارجيين إنشاء أدوات وعمليات تكامل تتفاعل مع برنامج Tournament Manager. بعض أنواع التكاملات (على سبيل المثال، محولات الفيديو أو العرض) مسموح بها، وبعضها الآخر (على سبيل المثال، شاشات عرض بديلة للمباريات) محظورة. توفر هذه المقالة نظرة عامة حول واجهة برمجة التطبيقات TM العامة ورابطًا لمزيد من المعلومات الشاملة.
ما هي واجهة برمجة التطبيقات العامة TM؟
- واجهة برمجة هي مجموعة من القواعد والأدوات التي تسمح لتطبيقات البرامج المختلفة بالتواصل مع بعضها البعض. الهدف من واجهة برمجة التطبيقات العامة TM هو توفير فرصة معترف بها رسميًا للأعضاء المتقدمين في مجتمع VEX لتطوير "ملحقات" أو "إضافات" Tournament Manager الخاصة بهم.
- تتضمن أمثلة التكاملات المشجعة/المسموح بها ما يلي:
- التسجيل التلقائي و/أو تحميل مباريات المنافسة الفردية
- التحكم في محول الفيديو لتحديد الكاميرا المرتبطة بالحقل النشط
- إضافة دعم Macropad
- التحكم في كاميرا PTZ للإشارة إلى المجال النشط
- التبديل تلقائيًا لاختيار شاشة عرض الجمهور استنادًا إلى الظروف المختلفة
- إنشاء زر "بدء المباراة" كبير الحجم بشكل مضحك
- تعتبر واجهة برمجة التطبيقات العامة TM في مراحلها المبكرة، ويتم توفيرها "كما هي" دون أي ضمان من أي نوع. على الرغم من أننا نأمل في الحفاظ على التوافق في المستقبل، فإننا نحتفظ بالحق في تعديل واجهة برمجة التطبيقات أو إيقافها في أي وقت.
ما هي الوظيفة المتوفرة؟
- جدول المباريات / النتائج
- التصنيفات
- نتائج المهارات
- تدفق الحدث (على سبيل المثال، اللحظة التي يتم فيها وضع المباريات في قائمة انتظار الحقول، وبدء المباراة، وما إلى ذلك)
- أوامر التحكم في المباراة الأساسية (على سبيل المثال، البدء/الإيقاف، وضع المباراة التالية في قائمة الانتظار)
ما هي الوظيفة التي لا تتوفر في؟
- أي شيء متعلق بـ "الكتابة" أو "التحرير"
- تحرير أو إرسال النتائج
- معلومات في الوقت الفعلي أثناء المباراة (على سبيل المثال، النتائج المباشرة)
- تحرير معلومات الفريق
- تعديل تكوين الحدث (على سبيل المثال، مجموعات الحقول، وإنشاء جداول المباريات، وما إلى ذلك)
أنا شريك حدث؛ كيف يمكنني تفعيل واجهة برمجة التطبيقات إذا كنت أرغب في استخدام أدوات الطرف الثالث في حدثي؟
- افتح مدير البطولة وحدد قائمة الأدوات، ثم الخيارات. عند فتح نافذة الخيارات، حدد فئة النشر على الويب. قم بتحديد مربع الاختيار "تمكين واجهة برمجة التطبيقات المحلية TM" ثم احفظ التغييرات.
- سيتعين القيام بذلك في كل مرة يتم فيها إنشاء حدث جديد.
أنا مطور؛ كيف أبدأ التطوير باستخدام واجهة برمجة التطبيقات TM؟
- يمكن العثور على مزيد من المعلومات في دليل واجهة برمجة التطبيقات العامة لمدير البطولة .
- للبدء، قم بإرسال طلب بيانات اعتماد واجهة برمجة التطبيقات على هذا الرابط وأخبرنا بما تعمل عليه. لا تقلق؛ طالما أن طلبك المقصود يقع ضمن الإرشادات المذكورة أدناه، فيجب الموافقة عليه. سيساعدك هذا على التأكد من أنك لا تضع طاقة التطوير في شيء لن يُسمح به لاحقًا!
القواعد & اللوائح
- يجب أن تتبع تطبيقات الطرف الثالث جميع المتطلبات الفنية المدرجة في دليل واجهة برمجة التطبيقات العامة TM (على سبيل المثال، توقيع الطلب، ومعرف التطبيق، ومفاتيح واجهة برمجة التطبيقات، وما إلى ذلك).
- يجب أن يطلب من المستخدم "الاشتراك" يدويًا أو تمكين الوظيفة الإضافية يدويًا عبر الأدوات > الإعدادات > النشر على الويب > "تمكين واجهة برمجة التطبيقات المحلية TM".
- قد تكون الأشياء التالية ممكنة من الناحية الفنية في واجهة برمجة التطبيقات التجريبية، ولكن محظورة صراحةً. سيتم تعطيل التطبيقات التي يتم اكتشاف انتهاكها لهذه الإرشادات وإلغاء بيانات اعتماد واجهة برمجة التطبيقات الخاصة بها.
- عرض أي نوع من أوقات المباراة، أو تعديل أي شيء متعلق بوقت المباراة، بخلاف المعلومات الواردة في مجرى أحداث واجهة برمجة التطبيقات.
- إن الحفاظ على الوقت الدقيق، ومزامنته بشكل صحيح عبر جميع الأجهزة الممكنة، يعد تحديًا معقدًا بشكل مدهش ومتشابك في العديد من أجزاء قاعدة بيانات TM الأساسية.
- من المستحيل التنبؤ بالعواقب غير المقصودة التي قد تنتج عن توفير الوصول إلى هذا من خلال واجهة برمجة التطبيقات العامة، ولا نريد وضع EPs والفرق في موقف لا يكونون فيه متأكدين مما إذا كان بإمكانهم الثقة في الوقت المعروض على شاشاتهم.
-
إعادة إنشاء أي وظيفة موجودة (على سبيل المثال، إنشاء "TM Mobile" الخاص بك)
- إن الحفاظ على تجربة حدث أساسية متسقة هو مبدأ أساسي في نموذج حدث مؤسسة REC. يجب أن تكون الفرق قادرة على الثقة في أن الأدوات الأساسية المستخدمة في حدثها هي نفسها المستخدمة في أي مكان آخر، وأن المتطوعين ذوي الخبرة في حدث واحد يمكنهم الانتقال إلى حدث آخر مع الحد الأدنى من التدريب - سواء كان أصغر حدث دوري أو أكبر حدث مميز!
- إذا كانت لديك أفكار حول كيفية تحسين وظيفة موجودة، فأخبرنا بذلك مباشرة! ينبغي كتابة التغييرات التي توفر تجربة مستخدم أفضل فعليًا في الذاكرة التجارية بشكل مباشر وإتاحتها لجميع الأحداث.
- تعديل أو إعادة إنشاء أي عروض للجمهور
- بالإضافة إلى ملاحظات التناسق المذكورة أعلاه، فإن المحتوى المتضمن في عروض الجمهور الرسمية هو نتيجة لعمليات فحص التصميم & بين رعاة مؤسسة REC ومجموعات إمكانية الوصول وفرق التسويق / إدارة العلامة التجارية.
- على الرغم من أن تعديلات العرض قد تبدو بريئة في سياق حدث واحد، إلا أنها في كثير من الأحيان يمكن أن يكون لها عواقب غير مقصودة تؤثر على مؤسسة REC على نطاق أوسع (على سبيل المثال، اتفاقيات الرعاية أو القيود المفروضة على استخدام صورة محمية بحقوق الطبع والنشر).
- الوصول إلى أي مكونات داخلية لـ Tournament Manager أو تعديلها خارج بروتوكولات API المفتوحة الرسمية
- تشكل التعديلات التي يتم إجراؤها بواسطة جهات خارجية، عندما يتم إنشاؤها بشكل غير رسمي، خطرًا محتملاً يهدد سلامة الحدث. تم إنشاء نقاط دخول واجهة برمجة التطبيقات الرسمية عمدًا كطريق معروف لإضافات الطرف الثالث التي تقلل أو تقضي على هذا الخطر.
- إن التعديلات خارج هذه القنوات، بالإضافة إلى كونها تشكل انتهاكًا لهذه الإرشادات، قد تؤدي إلى وضع EPs أو الفرق في موقف لا يمكنهم فيه الثقة في البرنامج الذي يدير حدثهم.
- عرض أي نوع من أوقات المباراة، أو تعديل أي شيء متعلق بوقت المباراة، بخلاف المعلومات الواردة في مجرى أحداث واجهة برمجة التطبيقات.
- ملحوظة: هذه منطقة غير مستكشفة بالنسبة لنا أيضًا! قد يكون لدينا بعض الأفكار حول ما قد يثير اهتمام مجتمع أدوات TM، ولكن إبداعك لا يتوقف أبدًا عن تجاوز توقعاتنا. لذا، فمن المرجح أن تتطور هذه المبادئ التوجيهية بمرور الوقت مع توسع برنامج أدوات العلامة التجارية ونبدأ في رؤية ما سيأتي منه!
- كتذكير، يُمنع منعًا أي استخدام لبرامج غير مصرح بها أو معدلة بشكل غير قانوني (أي البرامج التي تنتهك أيًا من هذه الإرشادات) في حدث تأهيلي رسمي.
- بالنسبة للمطورين، سيؤدي هذا إلى إلغاء بيانات اعتماد واجهة برمجة التطبيقات الخاصة بهم وتعطيل تطبيقاتهم.
- بالنسبة للطلاب أو أعضاء الفريق الآخرين، سيتم التعامل مع هذا باعتباره انتهاكًا لقواعد السلوك الخاصة بمؤسسة REC.
- بالنسبة لشركاء الحدث، سيتم التعامل مع هذا باعتباره انتهاكًا لالتزام بالتميز في الحدث.