TM Public API

• API — це набір правил і інструментів, які дозволяють різним програмам програмного забезпечення спілкуватися один з одним. Метою TM Public API є надання офіційно визнаної можливості досвідченим членам спільноти VEX розробляти власні «розширення» або «додатки» для Tournament Manager.
• Приклади рекомендованих/дозволених інтеграцій включають:
  • Автоматичний запис і/або завантаження окремих змагань
  • Керування перемикачем відео для вибору камери, пов’язаної з активним полем
  • Додавання підтримки макропада
  • Управління поворотною камерою для вказівки на активне поле
  • Автоматичне перемикання вибору екрана відображення аудиторії на основі різних умов
  • Створення комічно великої кнопки «Почати матч».
• TM Public API знаходиться на ранніх стадіях і надається «як є» без будь-яких гарантій. Хоча ми сподіваємося підтримувати сумісність у майбутньому, ми залишаємо за собою право змінювати або припиняти API у будь-який час.

Які функції є доступними?

• Розклад / результати матчів
• Рейтинги
• Результати навичок
• Потік подій (наприклад, момент, коли збіги ставляться в чергу до полів, починається збіг тощо)
• Основні команди керування збігом (наприклад, почати/зупинити, поставити наступний матч у чергу)

Яка функція НЕ доступна?

• Все, що пов’язано з «записом» або «редагуванням».
• Редагування або надсилання балів
• Інформація в реальному часі під час матчу (наприклад, результати в прямому ефірі)
• Редагування інформації про команду
• Зміна конфігурації події (наприклад, набори полів, створення розкладів матчів тощо)

Я партнер заходу; як увімкнути API, якщо я хочу використовувати інструменти сторонніх розробників на своїй події?

• Відкрийте менеджер турнірів і виберіть меню «Інструменти», а потім «Параметри». Коли відкриється вікно «Параметри», виберіть категорію «Веб-публікація». Поставте прапорець «Увімкнути локальний API TM» і збережіть зміни.
• Це потрібно буде робити кожного разу, коли створюється нова подія.

Я розробник; як почати розробку за допомогою TM API?

• Додаткову інформацію можна знайти в Посібнику з публічного API для Tournament Manager.
• Щоб почати, надішліть запит облікових даних API за цим посиланням і розкажіть нам про те, над чим ви працюєте. Не хвилюйтеся; якщо ваша запланована заявка відповідає наведеним нижче вказівкам, її слід схвалити. Це допоможе переконатися, що ви не вкладаєте енергію розвитку в те, що згодом буде заборонено!

Правила & Регламент

• Програми сторонніх розробників мають відповідати всім технічним вимогам, наведеним у TM Public API Guide (наприклад, підпис запиту, ідентифікатор програми, ключі API тощо)
• Необхідно вимагати від користувача вручну «ввімкнути» або ввімкнути надбудову вручну за допомогою інструментів > налаштувань > веб-публікацій > «увімкнути локальний TM API».
• Наступні речі можуть бути технічно можливими в бета-версії API, але явно заборонені. Програми, які порушують ці вказівки, буде вимкнено, а їхні облікові дані API відкликано.
  • Відображення будь-якого типу часу збігуабо зміна будь-чого, що стосується часу збігу, окрім інформації, що міститься в потокі подій API.
    • Підтримання точного часу та його правильна синхронізація на всіх можливих пристроях є напрочуд складною проблемою, яка переплетена в багатьох частинах основної кодової бази ТМ.
    • Неможливо передбачити, до яких небажаних наслідків може призвести надання доступу до цього через загальнодоступний API, і ми не хочемо, щоб EP та команди були в такому становищі, коли вони не впевнені, чи можуть вони довіряти часу, який відображається на їхні екрани.
  • Відтворення будь-якої існуючої функції (наприклад, створення власного «TM Mobile»)
    • Основним принципом моделі заходів REC Foundation є підтримка сталого досвіду основної події. Команди повинні бути впевнені, що фундаментальні інструменти, які використовуються на їхньому заході, такі ж, як і в будь-якому іншому місці, і що волонтери, які мають досвід участі в одному заході, можуть перейти до іншого заходу з мінімальною підготовкою — будь то найменший захід ліги чи найбільша фірмова подія!
    • Якщо у вас є ідеї щодо покращення наявної функції, повідомте нам про це безпосередньо! Зміни, які справді забезпечують кращий досвід користувача, мають бути записані безпосередньо в TM і доступні для всіх подій.
  • Зміна або повторне створення будь-яких показів аудиторії
    • На додаток до зазначених вище приміток щодо узгодженості, вміст, включений до офіційних показів аудиторії, є результатом критичних процесів перевірки дизайну & між спонсорами REC Foundation, групами доступності та командами маркетингу/менеджменту бренду.
    • Незважаючи на те, що модифікації відображення можуть здаватися невинними в контексті однієї події, вони часто можуть мати непередбачені наслідки, які вплинуть на фонд REC у більшому масштабі (наприклад, угоди про спонсорство або обмеження на використання зображення, захищеного авторським правом).
  • Доступ або зміна будь-яких внутрішніх компонентів Tournament Manager за межами офіційних відкритих протоколів API
    • Неофіційні модифікації сторонніх розробників створюють потенційний ризик порушення цілісності події. Офіційні точки входу API навмисно створено як відомий шлях для сторонніх розширень, який мінімізує або усуває цей ризик.
    • Зміни за межами цих каналів, окрім того, що є порушенням цих вказівок, можуть поставити EP або команди в положення, коли вони не можуть довіряти програмному забезпеченню, яке запускає їхні події.
• Примітка: Для нас це теж незвідана територія! У нас можуть бути ідеї щодо інструментів TM, які можуть зацікавити спільноту, але ваша креативність завжди перевершує наші очікування. Отже, ці вказівки, швидше за все, будуть розвиватися з часом, оскільки програма TM Tools розширюється, і ми починаємо бачити, що з цього виходить!
• Нагадуємо, що будь-яке використання несанкціонованого або незаконно модифікованого програмного забезпечення (тобто програмного забезпечення, яке порушує будь-яку з цих інструкцій) в офіційних кваліфікаційних змаганнях суворо заборонено.
  • Для розробників це призведе до відкликання облікових даних API та вимкнення програм.
  • Для студентів або інших членів команди це буде розглядатися як порушення Кодексу поведінки REC Foundation.
  • Для партнерів заходу це розглядатиметься як порушення зобов’язань щодо досконалості заходу.