1. Библиотека RECF
  2. Партнеры мероприятия
  3. Запуск событий
  4. Использование программного обеспечения Tournament Manager

TM Публичный API

Открытый API Tournament Manager (TM) позволяет сторонним разработчикам создавать инструменты и интеграции, взаимодействующие с программным обеспечением Tournament Manager. Некоторые типы интеграций (например, переключатели видео или дисплеев) разрешены, а другие (например, альтернативные дисплеи таймера матча) запрещены. В этой статье представлен обзор TM Public API и ссылка на более полную информацию.

Что такое публичный API TM?

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

Какая функциональность доступна?

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

Какая функциональность НЕ доступна?

  • Все, что связано с «написанием» или «редактированием»
  • Редактирование или отправка оценок
  • Информация в режиме реального времени во время матча (например, текущий счет)
  • Редактирование информации о команде
  • Изменение конфигурации событий (например, наборы полей, создание расписаний матчей и т. д.)

Я партнер мероприятия. Как мне включить API, если я хочу использовать сторонние инструменты на своем мероприятии?

  • Откройте Tournament Manager и выберите меню «Инструменты», затем «Параметры». Когда откроется окно «Параметры», выберите категорию «Веб-публикация». Установите флажок «Включить локальный API TM» и сохраните изменения.
  • Это необходимо будет делать каждый раз при создании нового события.

Я разработчик. Как мне начать разработку с использованием TM API?

  • Более подробную информацию можно найти в Руководстве по публичному API Tournament Manager .
  • Чтобы начать работу, отправьте запрос на учетные данные API по этой ссылке и расскажите нам, над чем вы работаете. Не волнуйтесь: если ваша заявка соответствует перечисленным ниже правилам, она должна быть одобрена. Это поможет вам быть уверенными в том, что вы не вкладываете энергию в разработку чего-то, что в конечном итоге не будет разрешено в будущем!

Правила & Положения

  • Сторонние приложения должны соответствовать всем техническим требованиям, перечисленным в Руководстве по публичному API TM (например, подпись запроса, идентификатор приложения, ключи API и т. д.)
  • Необходимо, чтобы пользователь вручную «подписался» или включил надстройку вручную через Инструменты > Настройки > Веб-публикация > «Включить локальный API TM».
  • Следующие вещи технически возможны в бета-версии API, но явно . Приложения, нарушающие эти правила, будут отключены, а их учетные данные API будут аннулированы.
    • Отображение любого типа времени матчаили изменение чего-либо, связанного со временем матча, за исключением информации, содержащейся в потоке событий API.
      • Поддержание точного времени и его правильная синхронизация на всех возможных устройствах — это на удивление сложная задача, которая пронизывает многие части базовой кодовой базы TM.
      • Невозможно предсказать, к каким непредвиденным последствиям может привести предоставление доступа к этой информации через общедоступный API, и мы не хотим ставить руководителей проектов и команды в положение, когда они не будут уверены, можно ли доверять времени, отображаемому на их экранах.
    • Воссоздание любой существующей функциональности (например, создание собственного «TM Mobile»)
      • Поддержание единообразия основного опыта проведения мероприятия является основополагающим принципом модели мероприятий Фонда REC. Команды должны быть уверены в том, что основные инструменты, используемые на их мероприятии, такие же, как и те, которые используются где-либо еще, и что волонтеры, имеющие опыт работы на одном мероприятии, могут перейти на другое мероприятие с минимальной подготовкой — будь то самое маленькое мероприятие лиги или крупнейшее знаковое событие!
      • Если у вас есть идеи по улучшению существующей функции, сообщите нам об этом напрямую! Изменения, которые действительно улучшают пользовательский опыт, должны быть напрямую записаны в память переводов и доступны для всех мероприятий.
    • Изменение или повторное создание любых показов аудитории
      • В дополнение к примечаниям о согласованности, упомянутым выше, контент, включенный в официальные показы для аудитории, является результатом & процессов проверки дизайна между спонсорами Фонда REC, группами по обеспечению доступности и командами по маркетингу/управлению брендом.
      • Даже если изменения в экспозиции могут показаться невинными в контексте одного события, они часто могут иметь непреднамеренные последствия, которые влияют на Фонд REC в более широком масштабе (например, спонсорские соглашения или ограничения на использование изображения, защищенного авторским правом).
    • Доступ или изменение любых внутренних компонентов Tournament Manager за пределами официальных открытых протоколов API
      • Модификации третьих лиц, созданные неофициально, представляют потенциальный риск нарушения целостности события. Официальные точки входа API были намеренно созданы как известный путь для сторонних расширений, который минимизирует или устраняет этот риск.
      • Изменения, вносимые за пределами этих каналов, помимо того, что являются нарушением настоящих правил, могут поставить исполнительных директоров или команды в положение, когда они не смогут доверять программному обеспечению, управляющему их мероприятием.
  • Примечание: Для нас это тоже неизведанная территория! У нас могут быть некоторые идеи относительно того, какие инструменты TM могут быть интересны сообществу, но ваша креативность никогда не перестает превосходить наши ожидания. Таким образом, эти рекомендации, скорее всего, будут со временем меняться по мере расширения программы TM Tools, и мы начнем видеть, что из этого выйдет!
  • Напоминаем, что любое использование несанкционированного или незаконно модифицированного программного обеспечения (т. е. программного обеспечения, которое нарушает какие-либо из этих правил) в официальном квалификационном мероприятии запрещено1