Öffentliche TM-API

Die öffentliche API des Tournament Manager (TM) ermöglicht es Drittanbietern, Tools und Integrationen zu erstellen, die mit der Tournament Manager-Software kompatibel sind. Einige Arten der Integration (z. B. Video- oder Anzeigeumschalter) sind zulässig, andere (z. B. alternative Spieltimeranzeigen) sind verboten. Dieser Artikel bietet einen Überblick über die TM Public API und einen Link zu umfassenderen Informationen.

Was ist die TM Public API?

• Eine API ist ein Satz von Regeln und Tools, die es verschiedenen Softwareanwendungen ermöglichen, miteinander zu kommunizieren. Das Ziel der TM Public API besteht darin, fortgeschrittenen Mitgliedern der VEX-Community eine offiziell anerkannte Möglichkeit zu bieten, ihre eigenen Tournament Manager-„Erweiterungen“ oder „Add-ons“ zu entwickeln.
• Beispiele für empfohlene/zulässige Integrationen sind:
  • Automatisches Aufzeichnen und/oder Hochladen einzelner Wettkampfspiele
  • Steuerung eines Videoumschalters zur Auswahl einer dem aktiven Feld zugeordneten Kamera
  • Hinzufügen von Macropad-Unterstützung
  • Steuern einer PTZ-Kamera, um auf das aktive Feld zu zeigen
  • Automatisches Umschalten der Bildschirmauswahl für die Zuschaueranzeige basierend auf verschiedenen Bedingungen
  • Erstellen einer lächerlich großen Schaltfläche „Spiel starten“
• Die TM Public API befindet sich noch in der Anfangsphase und wird „wie besehen“ und ohne jegliche Gewährleistung bereitgestellt. Obwohl wir hoffen, die Kompatibilität auch in Zukunft aufrechtzuerhalten, behalten wir uns das Recht vor, die API jederzeit zu ändern oder einzustellen.

Welche Funktionalität ist verfügbar?

• Spielplan/Ergebnisse
• Ranglisten
• Kompetenzergebnisse
• Ereignisstrom (z. B. der Moment, in dem Spiele in die Warteschlange für Felder gestellt werden, Spiele beginnen usw.)
• Grundlegende Spielsteuerungsbefehle (z. B. Start/Stopp, nächstes Spiel in die Warteschlange stellen)

Welche Funktionalität ist NICHT verfügbar?

• Alles, was mit „Schreiben“ oder „Bearbeiten“ zu tun hat
• Bearbeiten oder Einreichen von Partituren
• Echtzeitinformationen während eines Spiels (z. B. Live-Ergebnisse)
• Teaminformationen bearbeiten
• Ändern der Ereigniskonfiguration (z. B. Feldsätze, Erstellen von Spielplänen usw.)

Ich bin ein Eventpartner. Wie aktiviere ich die API, wenn ich bei meinem Event Tools von Drittanbietern verwenden möchte?

• Öffnen Sie den Turniermanager, wählen Sie das Menü „Extras“ und dann „Optionen“. Wenn das Fenster „Optionen“ geöffnet wird, wählen Sie die Kategorie „Web-Publishing“. Aktivieren Sie das Kontrollkästchen „Lokale TM-API aktivieren“ und speichern Sie die Änderungen.
• Dies muss jedes Mal durchgeführt werden, wenn ein neues Ereignis erstellt wird.

Ich bin Entwickler. Wie beginne ich mit der Entwicklung mit der TM-API?

• Weitere Informationen finden Sie im Tournament Manager Public API Guide.
• Senden Sie zunächst unter diesem Link eine API-Anmeldeinformationsanforderung und erzählen Sie uns, woran Sie arbeiten. Keine Sorge. Solange Ihr Antrag den unten aufgeführten Richtlinien entspricht, sollte er genehmigt werden. Damit stellen Sie sicher, dass Sie Ihre Entwicklungsenergie nicht in etwas stecken, was später nicht mehr zugelassen wird!

Regeln & Vorschriften

• Anwendungen von Drittanbietern müssen alle im TM Public API Guide aufgeführten technischen Anforderungen erfüllen (z. B. Anforderungssignierung, App-ID, API-Schlüssel usw.).
• Der Benutzer muss sich manuell anmelden oder das Add-on manuell über Extras > Einstellungen > Web Publishing > „Lokale TM-API aktivieren“ aktivieren.
• Die folgenden Dinge können in der Beta-API technisch möglich sein, sind aber ausdrücklich verboten. Anwendungen, die gegen diese Richtlinien verstoßen, werden deaktiviert und ihre API-Anmeldeinformationen werden widerrufen.
  • Anzeige jeglicher Art von Übereinstimmungszeitoder Änderung jeglicher mit der Übereinstimmungszeit zusammenhängender Informationen, mit Ausnahme der im Ereignisstrom der API enthaltenen Informationen.
    • Die genaue Zeitangabe und deren korrekte Synchronisierung auf allen möglichen Geräten ist eine überraschend komplexe Herausforderung, die sich durch viele Teile des TM-Kerncodes zieht.
    • Es ist unmöglich vorherzusagen, welche unbeabsichtigten Konsequenzen sich aus der Bereitstellung des Zugriffs hierauf über eine öffentlich zugängliche API ergeben können, und wir möchten EPs und Teams nicht in eine Lage bringen, in der sie sich nicht sicher sind, ob sie der auf ihren Bildschirmen angezeigten Zeit vertrauen können.
  • Neuerstellung jeglicher vorhandener Funktionalität (z. B. Erstellen eines eigenen „TM Mobile“)
    • Ein grundlegender Grundsatz des Veranstaltungsmodells der REC Foundation besteht darin, ein konsistentes Kernerlebnis bei der Veranstaltung aufrechtzuerhalten. Die Teams sollten darauf vertrauen können, dass bei ihrer Veranstaltung dieselben grundlegenden Tools zum Einsatz kommen wie überall sonst auch, und dass Freiwillige, die bereits Erfahrung mit einer Veranstaltung haben, mit minimaler Schulung zu einer anderen Veranstaltung wechseln können – ganz gleich, ob es sich um die kleinste Ligaveranstaltung oder das größte Signature Event handelt!
    • Wenn Du Ideen hast, wie eine bestehende Funktion verbessert werden könnte, lass es uns direkt wissen! Änderungen, die tatsächlich zu einem besseren Benutzererlebnis führen, sollten direkt in TM geschrieben und für alle Events verfügbar sein.
  • Ändern oder Neuerstellen von Zielgruppenanzeigen
    • Zusätzlich zu den oben genannten Konsistenzhinweisen sind die in den offiziellen Zielgruppendisplays enthaltenen Inhalte das Ergebnis kritischer Design & Überprüfungsprozesse zwischen den Sponsoren der REC Foundation, Zugänglichkeitsgruppen und Marketing-/Markenmanagementteams.
    • Auch wenn Anzeigeänderungen im Rahmen einer einzelnen Veranstaltung harmlos erscheinen mögen, können sie häufig unbeabsichtigte Konsequenzen haben, die sich im größeren Maßstab auf die REC Foundation auswirken (z. B. Sponsoringvereinbarungen oder Einschränkungen bei der Verwendung eines urheberrechtlich geschützten Bildes).
  • Zugriff auf oder Änderung von internen Komponenten des Tournament Managers außerhalb der offiziellen offenen API-Protokolle
    • Inoffiziell vorgenommene Änderungen durch Dritte bergen das potenzielle Risiko einer Beeinträchtigung der Ereignisintegrität. Die offiziellen API-Einstiegspunkte wurden absichtlich als bekannter Weg für Erweiterungen von Drittanbietern erstellt, um dieses Risiko zu minimieren oder zu eliminieren.
    • Änderungen außerhalb dieser Kanäle stellen nicht nur einen Verstoß gegen diese Richtlinien dar, sondern können auch dazu führen, dass EPs oder Teams der Software, mit der ihr Event durchgeführt wird, nicht mehr vertrauen können.
• Hinweis: Auch für uns ist dies Neuland! Wir haben vielleicht einige Ideen, welche TM-Tools für die Community von Interesse sein könnten, aber Ihre Kreativität übertrifft stets unsere Erwartungen. Daher werden sich diese Richtlinien wahrscheinlich im Laufe der Zeit weiterentwickeln, wenn das TM Tools-Programm erweitert wird und wir sehen, was dabei herauskommt!
• Zur Erinnerung: Jede Verwendung nicht autorisierter oder illegal modifizierter Software (d. h. Software, die gegen eine dieser Richtlinien verstößt) in einem offiziellen Qualifikationsevent ist strengstens verboten.
  • Für Entwickler führt dies dazu, dass ihre API-Anmeldeinformationen widerrufen und ihre Anwendungen deaktiviert werden.
  • Für Studierende oder andere Teammitglieder wird dies als Verstoß gegen den Verhaltenskodex der REC Foundationgewertet.
  • Für Eventpartner wird dies als Verstoß gegen das Commitment to Event Excellencebehandelt.