TM Openbare API

Met de openbare API van Tournament Manager (TM) kunnen externe ontwikkelaars tools en integraties bouwen die samenwerken met de Tournament Manager-software. Sommige soorten integraties (bijvoorbeeld video- of displayswitchers) zijn toegestaan, terwijl andere (bijvoorbeeld alternatieve wedstrijdtimerweergaven) verboden zijn. Dit artikel biedt een overzicht van de TM Public API en een link naar uitgebreidere informatie.

Wat is de TM Public API?

• Een API is een set regels en hulpmiddelen waarmee verschillende softwaretoepassingen met elkaar kunnen communiceren. Het doel van de TM Public API is om een officieel erkende mogelijkheid te bieden aan gevorderde leden van de VEX-community om hun eigen Tournament Manager-‘extensies’ of ‘add-ons’ te ontwikkelen.
• Voorbeelden van aangemoedigde/toegestane integraties zijn:
  • Automatisch opnemen en/of uploaden van individuele competitiewedstrijden
  • Een videoswitcher bedienen om een camera te selecteren die is gekoppeld aan het actieve veld
  • Macropad-ondersteuning toevoegen
  • Een PTZ-camera besturen om naar het actieve veld te wijzen
  • Automatisch wisselen van de schermselectie voor het publiek op basis van verschillende omstandigheden
  • Een komisch grote "start match"-knop maken
• De TM Public API bevindt zich nog in een vroeg stadium en wordt geleverd “zoals het is”, zonder enige vorm van garantie. Hoewel we hopen dat de compatibiliteit in de toekomst behouden blijft, behouden we ons het recht voor om de API op elk gewenst moment te wijzigen of stop te zetten.

Welke functionaliteit is beschikbaar?

• Wedstrijdschema / uitslagen
• Ranglijsten
• Resultaten vaardigheden
• Gebeurtenisstroom (bijvoorbeeld het moment waarop wedstrijden in de wachtrij voor velden worden geplaatst, wedstrijden beginnen, enz.)
• Basisopdrachten voor wedstrijdbesturing (bijvoorbeeld starten/stoppen, volgende wedstrijd in de wachtrij zetten)

Welke functionaliteit is NIET beschikbaar?

• Alles wat met “schrijven” of “bewerken” te maken heeft
• Scores bewerken of indienen
• Realtime-informatie tijdens een wedstrijd (bijvoorbeeld livescores)
• Bewerken van teaminformatie
• Gebeurtenisconfiguratie wijzigen (bijvoorbeeld veldsets, wedstrijdschema's genereren, enz.)

Ik ben een evenementpartner. Hoe schakel ik de API in als ik tools van derden wil gebruiken op mijn evenement?

• Open Toernooibeheer en selecteer het menu Extra en vervolgens Opties. Wanneer het venster Opties wordt geopend, selecteert u de categorie Webpublicaties. Vink het vakje “Enable Local TM API” aan en sla de wijzigingen op.
• Dit moet u elke keer doen wanneer er een nieuw evenement wordt aangemaakt.

Ik ben een ontwikkelaar. Hoe kan ik beginnen met ontwikkelen met de TM API?

• Meer informatie vindt u in de Tournament Manager Public API Guide.
• Om te beginnen, dient u een API-referentieverzoek in via deze link en vertelt u ons waar u mee bezig bent. Maak u geen zorgen: zolang uw aanvraag binnen de onderstaande richtlijnen valt, wordt deze goedgekeurd. Zo voorkom je dat je ontwikkelingsenergie steekt in iets wat later toch niet is toegestaan!

Regels & Reglementen

• Toepassingen van derden moeten voldoen aan alle technische vereisten die in de TM Public API Guide staan vermeld (bijvoorbeeld aanvraagondertekening, app-ID, API-sleutels, enz.)
• De gebruiker moet zich handmatig 'aanmelden' of de add-on handmatig inschakelen via Extra > Instellingen > Webpublicatie > 'Lokale TM API inschakelen'.
• De volgende zaken zijn technisch gezien mogelijk in de bèta-API, maar zijn expliciet Applicaties die deze richtlijnen overtreden, worden uitgeschakeld en hun API-referenties worden ingetrokken.
  • Het weergeven van elk type matchtijdof het wijzigen van iets dat verband houdt met de matchtijd, anders dan de informatie die is opgenomen in de gebeurtenisstroom van de API.
    • Het nauwkeurig bijhouden van de tijd en het correct synchroniseren ervan op alle mogelijke apparaten is een verrassend complexe uitdaging die verweven is met veel onderdelen van de kerncodebase van TM.
    • Het is onmogelijk om te voorspellen welke onbedoelde gevolgen het biedt als we hiertoe toegang verlenen via een openbare API. Bovendien willen we EP's en teams niet in een positie brengen waarin ze niet zeker weten of ze de tijd op hun scherm kunnen vertrouwen.
  • Het creëren van bestaande functionaliteit (bijvoorbeeld door uw eigen “TM Mobile” te maken)
    • Het handhaven van een consistente kernervaring voor evenementen is een fundamenteel principe van het REC Foundation-evenementenmodel. Teams moeten erop kunnen vertrouwen dat de basistools die ze bij hun evenement gebruiken, dezelfde zijn als die elders worden gebruikt. Ook moeten vrijwilligers met ervaring bij één evenement met minimale training door kunnen stromen naar een ander evenement, ongeacht of het om het kleinste competitie-evenement of het grootste Signature Event gaat!
    • Als u ideeën heeft over hoe een bestaande functie verbeterd kan worden, laat het ons dan direct weten! Wijzigingen die daadwerkelijk voor een betere gebruikerservaring zorgen, moeten direct in TM worden opgenomen en voor alle evenementen beschikbaar zijn.
  • Wijzigen of opnieuw maken van publieksweergaven
    • Naast de hierboven genoemde consistentie-opmerkingen is de content die is opgenomen in de officiële publiekspresentaties het resultaat van kritische ontwerp- & beoordelingsprocessen tussen REC Foundation-sponsors, toegankelijkheidsgroepen en marketing-/merkmanagementteams.
    • Ook al lijken wijzigingen in de weergave in de context van een enkele gebeurtenis onschuldig, ze kunnen vaak onbedoelde gevolgen hebben die de REC Foundation op grotere schaal treffen (bijvoorbeeld sponsorovereenkomsten of beperkingen op het gebruik van een auteursrechtelijk beschermde afbeelding).
  • Toegang krijgen tot of wijzigen van interne componenten van Tournament Manager buiten de officiële open API-protocollen
    • Aanpassingen door derden die onofficieel worden gemaakt, vormen een potentieel risico voor het in gevaar brengen van de integriteit van het evenement. De officiële API-toegangspunten zijn opzettelijk gecreëerd als een bekende route voor extensies van derden, waarmee dit risico wordt geminimaliseerd of geëlimineerd.
    • Aanpassingen buiten deze kanalen om zijn niet alleen een schending van deze richtlijnen, maar kunnen er ook toe leiden dat EP's of teams niet meer kunnen vertrouwen op de software die hun evenement uitvoert.
• Let op: Ook voor ons is dit onontgonnen terrein! Wij hebben misschien wel ideeën over welke TM-tools de community interessant zou kunnen vinden, maar uw creativiteit overtreft altijd onze verwachtingen. Deze richtlijnen zullen zich waarschijnlijk in de loop van de tijd verder ontwikkelen, naarmate het TM Tools-programma zich uitbreidt en we beginnen te zien wat de resultaten zijn!
• Ter herinnering: elk gebruik van ongeautoriseerde of illegaal gewijzigde software (d.w.z. software die een van deze richtlijnen schendt) in een officieel kwalificatie-evenement is strengste verboden
  • Voor ontwikkelaars heeft dit tot gevolg dat hun API-referenties worden ingetrokken en hun applicaties worden uitgeschakeld.
  • Voor studenten of andere teamleden wordt dit beschouwd als een schending van de gedragscode van de REC Foundation.
  • Voor Event Partners wordt dit gezien als een schending van de Commitment to Event Excellence.