API publique TM

L'API publique Tournament Manager (TM) permet aux développeurs tiers de créer des outils et des intégrations qui interagissent avec le logiciel Tournament Manager. Certains types d'intégrations (par exemple, les commutateurs vidéo ou d'affichage) sont autorisés, tandis que d'autres (par exemple, les affichages alternatifs du chronomètre de match) sont interdits. Cet article fournit un aperçu de l'API publique TM et un lien vers des informations plus complètes.

Qu'est-ce que l'API publique TM ?

• Une API est un ensemble de règles et d’outils qui permettent à différentes applications logicielles de communiquer entre elles. L'objectif de l'API publique TM est de fournir une opportunité officiellement reconnue aux membres avancés de la communauté VEX de développer leurs propres « extensions » ou « modules complémentaires » de Tournament Manager.
• Voici quelques exemples d’intégrations encouragées/autorisées :
  • Enregistrement et/ou téléchargement automatique de matchs de compétition individuels
  • Contrôle d'un commutateur vidéo pour sélectionner une caméra associée au champ actif
  • Ajout de la prise en charge du macropad
  • Contrôler une caméra PTZ pour pointer vers le champ actif
  • Commutation automatique de la sélection de l'écran d'affichage du public en fonction de diverses conditions
  • Créer un bouton « démarrer le match » comiquement grand
• L'API publique TM en est à ses débuts et est fournie « telle quelle » sans aucune garantie. Bien que nous espérons maintenir la compatibilité à l’avenir, nous nous réservons le droit de modifier ou d’interrompre l’API à tout moment.

Quelle fonctionnalité est disponible?

• Calendrier des matchs / résultats
• Classements
• Résultats des compétences
• Flux d'événements (par exemple, le moment où les matchs sont mis en file d'attente sur les terrains, le début du match, etc.)
• Commandes de contrôle de match de base (par exemple, démarrer/arrêter, mettre en file d'attente le match suivant)

Quelle fonctionnalité n'est PAS disponible ?

• Tout ce qui concerne « l’écriture » ou « l’édition »
• Modification ou soumission de partitions
• Informations en temps réel pendant un match (par exemple, score en direct)
• Modification des informations sur l'équipe
• Modification de la configuration de l'événement (par exemple, ensembles de champs, génération de calendriers de match, etc.)

Je suis un partenaire événementiel ; comment activer l'API si je souhaite utiliser des outils tiers lors de mon événement ?

• Ouvrez Tournament Manager et sélectionnez le menu Outils, puis Options. Lorsque la fenêtre Options s’ouvre, sélectionnez la catégorie Publication Web. Cochez la case « Activer l’API TM locale » et enregistrez les modifications.
• Cela devra être fait à chaque fois qu'un nouvel événement est créé.

Je suis développeur ; comment puis-je commencer à développer avec l'API TM ?

• Vous trouverez plus d'informations dans le Guide de l'API publique de Tournament Manager .
• Pour commencer, soumettez une demande d'informations d'identification API à ce lien et dites-nous sur quoi vous travaillez. Ne vous inquiétez pas ; tant que votre demande est conforme aux directives énumérées ci-dessous, elle devrait être approuvée. Cela vous aidera à vous assurer que vous ne consacrez pas d’énergie de développement à quelque chose qui ne sera finalement pas autorisé plus tard !

Règles & Règlements

• Les applications tierces doivent respecter toutes les exigences techniques répertoriées dans le Guide de l'API publique TM (par exemple, signature de demande, ID d'application, clés API, etc.)
• Doit obliger l'utilisateur à « accepter » manuellement ou à activer le module complémentaire manuellement via Outils > Paramètres > Publication Web > « Activer l'API TM locale ».
• Les choses suivantes peuvent être techniquement possibles dans l'API bêta, mais sont explicitement interdites. Les applications trouvées en violation de ces directives seront désactivées et leurs informations d'identification API révoquées.
  • Affichage de tout type de temps de match, ou modification de tout élément lié au temps de match, autre que les informations contenues dans le flux d'événements de l'API.
    • Maintenir une heure précise et la synchroniser correctement sur tous les appareils possibles est un défi étonnamment complexe qui est étroitement lié à de nombreuses parties de la base de code principale de TM.
    • Il est impossible de prédire quelles conséquences imprévues peuvent résulter de l'accès à ces informations via une API publique, et nous ne voulons pas placer les EP et les équipes dans une position où ils ne sont pas sûrs de pouvoir faire confiance à l'heure affichée sur leurs écrans.
  • Recréer toute fonctionnalité existante (par exemple, créer votre propre « TM Mobile »)
    • Maintenir une expérience événementielle cohérente est un principe fondamental du modèle événementiel de la Fondation REC. Les équipes doivent pouvoir être sûres que les outils fondamentaux utilisés lors de leur événement sont les mêmes que ceux utilisés partout ailleurs, et que les bénévoles ayant de l'expérience lors d'un événement peuvent passer à un autre événement avec une formation minimale, qu'il s'agisse du plus petit événement de ligue ou du plus grand événement Signature !
    • Si vous avez des idées sur la façon dont une fonction existante pourrait être améliorée, faites-le nous savoir directement ! Les modifications qui offrent réellement une meilleure expérience utilisateur doivent être écrites directement dans TM et disponibles pour tous les événements.
  • La modification ou la recréation de n'importe quelle audience affiche
    • En plus des notes de cohérence mentionnées ci-dessus, le contenu inclus dans les affichages d'audience officiels est le résultat de processus de contrôle de conception & entre les sponsors de la Fondation REC, les groupes d'accessibilité et les équipes de gestion de marketing/marque.
    • Même si les modifications d'affichage peuvent sembler anodines dans le contexte d'un seul événement, elles peuvent souvent avoir des conséquences imprévues qui ont un impact sur la Fondation REC à plus grande échelle (par exemple, des accords de parrainage ou des limitations d'utilisation d'une image protégée par le droit d'auteur).
  • Accéder ou modifier des composants internes de Tournament Manager en dehors des protocoles API ouverts officiels
    • Les modifications apportées par des tiers, lorsqu’elles sont créées de manière non officielle, présentent un risque potentiel de compromettre l’intégrité de l’événement. Les points d’entrée officiels de l’API ont été intentionnellement créés comme une voie connue pour les extensions tierces qui minimisent ou éliminent ce risque.
    • Les modifications en dehors de ces canaux, en plus d'être une violation de ces directives, risquent de mettre les EP ou les équipes dans une position où ils ne peuvent pas faire confiance au logiciel qui gère leur événement.
• Remarque : c’est un territoire inexploré pour nous aussi ! Nous avons peut-être quelques idées sur les outils de TM qui pourraient intéresser la communauté, mais votre créativité ne cesse jamais de dépasser nos attentes. Ces lignes directrices évolueront donc probablement au fil du temps, à mesure que le programme TM Tools se développe et que nous commençons à voir ce qui en résulte !
• Pour rappel, toute utilisation de logiciel non autorisé ou modifié illégalement (c'est-à-dire un logiciel qui viole l'une de ces directives) lors d'un événement de qualification officiel est strictement interdite.
  • Pour les développeurs, cela entraînera la révocation de leurs informations d’identification API et la désactivation de leurs applications.
  • Pour les étudiants ou les autres membres de l’équipe, cela sera traité comme une violation du Code de conduite de la Fondation REC .
  • Pour les partenaires événementiels, cela sera considéré comme une violation de l’engagement envers l’excellence événementielle.