API pubblica TM

• Un'API è un insieme di regole e strumenti che consentono a diverse applicazioni software di comunicare tra loro. L'obiettivo della TM Public API è quello di fornire un'opportunità ufficialmente riconosciuta ai membri avanzati della comunità VEX di sviluppare le proprie "estensioni" o "componenti aggiuntivi" di Tournament Manager.
• Esempi di integrazioni incoraggiate/consentite includono:
  • Registrazione e/o caricamento automatico delle singole partite di competizione
  • Controllo di uno switcher video per selezionare una telecamera associata al campo attivo
  • Aggiunta del supporto macropad
  • Controllo di una telecamera PTZ per puntare al campo attivo
  • Commutazione automatica della selezione dello schermo di visualizzazione del pubblico in base a varie condizioni
  • Creare un pulsante "Inizia partita" comicamente grande
• L'API pubblica TM è nelle sue fasi iniziali e viene fornita "così com'è" senza alcuna garanzia. Anche se speriamo di mantenere la compatibilità in futuro, ci riserviamo il diritto di modificare o interrompere l'API in qualsiasi momento.

Quale funzionalità è disponibile?

• Calendario delle partite / risultati
• Classifiche
• Risultati delle competenze
• Flusso di eventi (ad esempio, il momento in cui le partite vengono messe in coda nei campi, l'inizio della partita, ecc.)
• Comandi di controllo di base delle partite (ad esempio, avvio/arresto, messa in coda della partita successiva)

Quale funzionalità NON è disponibile?

• Tutto ciò che riguarda "scrivere" o "modificare"
• Modifica o invio di punteggi
• Informazioni in tempo reale durante una partita (ad esempio, punteggio in tempo reale)
• Modifica delle informazioni del team
• Modifica della configurazione dell'evento (ad esempio, set di campi, generazione di calendari delle partite, ecc.)

Sono un partner dell'evento; come posso abilitare l'API se voglio utilizzare strumenti di terze parti durante il mio evento?

• Apri Tournament Manager e seleziona il menu Strumenti, quindi Opzioni. Quando si apre la finestra Opzioni, selezionare la categoria Pubblicazione Web. Selezionare la casella di controllo "Abilita API TM locale" e salvare le modifiche.
• Questa operazione dovrà essere eseguita ogni volta che si crea un nuovo evento.

Sono uno sviluppatore; come posso iniziare a sviluppare con la TM API?

• Per ulteriori informazioni, consultare la Guida API pubblica di Tournament Manager.
• Per iniziare, invia una richiesta di credenziali API a questo link e raccontaci a cosa stai lavorando. Non preoccuparti: se la tua richiesta rispetta le linee guida elencate di seguito, verrà approvata. Ciò ti aiuterà a garantire che non stai investendo energie di sviluppo in qualcosa che in seguito finirà per non essere più consentito!

Regole & Regolamenti

• Le applicazioni di terze parti devono rispettare tutti i requisiti tecnici elencati nella Guida API pubblica TM (ad esempio, firma della richiesta, ID app, chiavi API, ecc.)
• Deve richiedere all'utente di "accettare" manualmente o abilitare manualmente il componente aggiuntivo tramite Strumenti > Impostazioni > Pubblicazione Web > "Abilita API TM locale".
• Le seguenti cose potrebbero essere tecnicamente possibili nella versione beta dell'API, ma sono esplicitamente proibite. Le applicazioni che violano queste linee guida verranno disabilitate e le loro credenziali API verranno revocate.
  • Visualizzazione di qualsiasi tipo di tempo di partitao modifica di qualsiasi elemento correlato al tempo di partita, ad eccezione delle informazioni contenute nel flusso di eventi dell'API.
    • Mantenere un orario preciso e sincronizzarlo correttamente su tutti i dispositivi possibili è una sfida sorprendentemente complessa, che interessa numerose parti del codice di base della TM.
    • È impossibile prevedere quali conseguenze indesiderate potrebbero derivare dalla fornitura dell'accesso tramite un'API pubblica e non vogliamo mettere EP e team in una posizione in cui non siano sicuri di potersi fidare dell'ora visualizzata sui loro schermi.
  • Ricreare qualsiasi funzionalità esistente (ad esempio, creare il proprio "TM Mobile")
    • Mantenere un'esperienza di evento di base coerente è un principio fondamentale del modello di eventi della REC Foundation. I team devono poter contare sul fatto che gli strumenti fondamentali utilizzati nel loro evento siano gli stessi utilizzati altrove e che i volontari con esperienza in un evento possano passare a un altro evento con una formazione minima, che si tratti del più piccolo evento di campionato o del più grande evento esclusivo!
    • Se hai delle idee su come migliorare una funzione esistente, faccelo sapere direttamente! Le modifiche che garantiscono davvero una migliore esperienza utente dovrebbero essere scritte direttamente nella TM e rese disponibili a tutti gli eventi.
  • Modifica o ricreazione di qualsiasi visualizzazioni di pubblico
    • Oltre alle note di coerenza sopra menzionate, i contenuti inclusi nelle esposizioni ufficiali per il pubblico sono il risultato di processi di progettazione & verifica critici tra gli sponsor della REC Foundation, i gruppi di accessibilità e i team di marketing/gestione del marchio.
    • Anche se le modifiche alla visualizzazione possono sembrare innocenti nel contesto di un singolo evento, possono spesso avere conseguenze indesiderate che hanno un impatto sulla REC Foundation su larga scala (ad esempio, accordi di sponsorizzazione o limitazioni all'uso di un'immagine protetta da copyright).
  • Accesso o modifica di qualsiasi componente interno di Tournament Manager al di fuori dei protocolli API aperti ufficiali
    • Le modifiche di terze parti, se create in modo non ufficiale, rappresentano un potenziale rischio di compromettere l'integrità dell'evento. I punti di ingresso API ufficiali sono stati creati intenzionalmente come canale noto per estensioni di terze parti che riducono al minimo o eliminano questo rischio.
    • Le modifiche apportate al di fuori di questi canali, oltre a costituire una violazione di queste linee guida, potrebbero mettere gli EP o i team nella posizione di non potersi fidare del software che gestisce il loro evento.
• Nota: anche per noi questo è un territorio inesplorato! Potremmo avere qualche idea su quali TM Tools potrebbero interessare alla community, ma la vostra creatività non smette mai di superare le nostre aspettative. Quindi, è probabile che queste linee guida si evolvano nel tempo, man mano che il programma TM Tools si espande e iniziamo a vedere cosa ne deriva!
• Si ricorda che qualsiasi utilizzo di software non autorizzato o modificato illegalmente (vale a dire software che viola una qualsiasi di queste linee guida) in un evento di qualificazione ufficiale è severamente vietato.
  • Per gli sviluppatori, ciò comporterà la revoca delle credenziali API e la disabilitazione delle loro applicazioni.
  • Per gli studenti o gli altri membri del team, ciò sarà considerato una violazione del Codice di condotta della Fondazione .
  • Per i partner dell'evento, ciò sarà considerato una violazione per l'eccellenza dell'evento.