1. RECF könyvtár
  2. Rendezvénypartnerek
  3. Futó események
  4. A Tournament Manager szoftver használata

TM nyilvános API

A Tournament Manager (TM) nyilvános API lehetővé teszi a külső fejlesztők számára, hogy olyan eszközöket és integrációkat készítsenek, amelyek együttműködnek a Tournament Manager szoftverrel. Bizonyos típusú integrációk (pl. videó- ​​vagy kijelzőváltók) megengedettek, mások (pl. alternatív mérkőzésidőzítő-kijelzők) tilosak. Ez a cikk áttekintést nyújt a TM Public API-ról, és egy hivatkozást nyújt átfogóbb információkhoz.

Mi az a TM Public API?

  • A API olyan szabályok és eszközök halmaza, amelyek lehetővé teszik a különböző szoftveralkalmazások egymás közötti kommunikációját. A TM Public API célja, hogy hivatalosan elismert lehetőséget biztosítson a VEX közösség haladó tagjainak saját Tournament Manager „bővítményeik” vagy „kiegészítői” fejlesztésére.
  • Példák a javasolt/engedélyezett integrációkra:
    • Az egyes versenymérkőzések automatikus rögzítése és/vagy feltöltése
    • Videóváltó vezérlése az aktív mezőhöz társított kamera kiválasztásához
    • Macropad támogatás hozzáadása
    • PTZ kamera vezérlése az aktív mezőre mutatáshoz
    • A közönség képernyő-kiválasztásának automatikus váltása különböző feltételek alapján
    • Egy komikusan nagy „mérkőzés indítása” gomb készítése
  • A TM Public API a korai szakaszában jár, és „ahogy van” mindenféle garancia nélkül biztosított. Bár reméljük, hogy a jövőben is fenntartjuk a kompatibilitást, fenntartjuk a jogot, hogy bármikor módosítsuk vagy leállítsuk az API-t.

Milyen funkció érhető el?

  • Mérkőzések menetrendje / eredmények
  • Rangsorok
  • A készségek eredményei
  • Eseményfolyam (pl. az a pillanat, amikor a mérkőzések sorba kerülnek a mezőkre, a mérkőzések kezdete stb.)
  • Alapvető egyezésvezérlő parancsok (pl. start/stop, sorba állítás a következő mérkőzésen)

Milyen funkció érhető el?

  • Bármi, ami „írással” vagy „szerkesztéssel” kapcsolatos
  • Pontszámok szerkesztése vagy beküldése
  • Valós idejű információk a meccs alatt (pl. élő pontozás)
  • Csapatinformációk szerkesztése
  • Eseménykonfiguráció módosítása (pl. mezőkészletek, mérkőzésütemezések generálása stb.)

Eseménypartner vagyok; hogyan engedélyezhetem az API-t, ha harmadik féltől származó eszközöket szeretnék használni az eseményemen?

  • Nyissa meg a Tournament Managert, és válassza az Eszközök menüt, majd az Opciók menüpontot. Amikor megnyílik a Beállítások ablak, válassza ki a Webes közzététel kategóriát. Jelölje be a „Helyi TM API engedélyezése” jelölőnégyzetet, és mentse a módosításokat.
  • Ezt minden alkalommal meg kell tenni, amikor új esemény jön létre.

fejlesztő vagyok; hogyan kezdjem el a fejlesztést a TM API-val?

  • További információk a Tournament Manager Public API Guide-ben találhatók.
  • A kezdéshez küldjön be egy API-hitelesítési kérelmet ezen a linken , és mondja el, hogy min dolgozik. Ne aggódj; mindaddig, amíg a tervezett kérelme megfelel az alább felsorolt ​​irányelveknek, azt jóvá kell hagyni. Ez segít megbizonyosodni arról, hogy ne fordítson fejlesztési energiát olyasmire, amit a későbbiekben nem engednek meg!

Szabályok & Szabályok

  • A harmadik féltől származó alkalmazásoknak meg kell felelniük a TM Public API Guide-ban felsorolt ​​összes műszaki követelménynek (pl. kérelem aláírása, alkalmazásazonosító, API-kulcsok stb.)
  • Meg kell követelnie a felhasználótól, hogy manuálisan „feliratkozzon” vagy engedélyezze a bővítményt az Eszközök > Beállítások > Webes közzététel > „Helyi TM API engedélyezése” menüpontjában.
  • A következő dolgok technikailag lehetségesek lehetnek a béta API-ban, de kifejezetten tiltottak. Az ezen irányelveket megsértő alkalmazásokat letiltjuk, és API-hitelesítési adataikat visszavonjuk.
    • Bármilyen típusú mérkőzésidőmegjelenítése, vagy bármi, ami a mérkőzés idejével kapcsolatos, módosítása, kivéve az API eseményfolyamában található információkat.
      • A pontos idő betartása és annak megfelelő szinkronizálása az összes lehetséges eszköz között meglepően összetett kihívás, amely a TM kódbázisának számos részében összefonódik.
      • Lehetetlen megjósolni, milyen nem kívánt következményekkel járhat, ha nyilvános API-n keresztül hozzáférést biztosítunk ehhez, és nem akarjuk olyan helyzetbe hozni az EP-ket és a csapatokat, ahol nem biztosak abban, hogy megbízhatnak-e a képernyőn megjelenő időben. a képernyőjüket.
    • Bármely meglévő funkció újbóli létrehozása (pl. saját „TM Mobile” készítése)
      • A következetes alapvető rendezvényélmény fenntartása a REC Alapítvány rendezvénymodelljének alapelve. A csapatoknak képesnek kell lenniük bízni abban, hogy a rendezvényükön használt alapvető eszközök ugyanazok, mint bárhol máshol, és hogy az egyik eseményen tapasztalattal rendelkező önkéntesek minimális képzéssel átugorhatnak egy másik eseményre – legyen szó akár a legkisebb bajnoki eseményről, akár a legnagyobb aláírási esemény!
      • Ha van ötlete, hogyan lehetne továbbfejleszteni egy meglévő funkciót, tudassa velünk közvetlenül! A valóban jobb felhasználói élményt biztosító változtatásokat közvetlenül a TM-be kell írni, és minden esemény számára elérhetővé kell tenni.
    • Bármely közönség módosítása vagy újbóli létrehozása
      • A fent említett konzisztencia megjegyzéseken túlmenően a hivatalos közönségmegjelenítéseken szereplő tartalom a REC Alapítvány szponzorai, akadálymentesítési csoportjai és marketing-/márkamenedzsment csapatai közötti kritikus tervezési & átvilágítási folyamatok eredménye.
      • Annak ellenére, hogy a megjelenítési módosítások ártatlannak tűnhetnek egyetlen esemény összefüggésében, gyakran nem szándékos következményekkel járhatnak, amelyek nagyobb léptékben érintik a REC Alapítványt (pl. szponzori megállapodások vagy a szerzői joggal védett kép használatának korlátozása).
    • A Tournament Manager bármely belső összetevőjének elérése vagy módosítása a hivatalos nyílt API protokollokon kívül
      • A harmadik féltől származó módosítások, ha nem hivatalosan hozzák létre, potenciálisan veszélyeztetik az események integritását. A hivatalos API belépési pontokat szándékosan úgy hozták létre, hogy a harmadik féltől származó bővítmények ismert csatornájaként minimálisra csökkentsék vagy kiküszöböljék ezt a kockázatot.
      • Az ezeken a csatornákon kívüli módosítások amellett, hogy megsértik ezeket az irányelveket, azt kockáztathatják, hogy az EP-k vagy csapatok olyan helyzetbe kerüljenek, ahol nem bízhatnak az eseményüket futtató szoftverben.
  • Megjegyzés: Ez számunkra is feltáratlan terület! Lehet, hogy van néhány ötletenk, hogy milyen TM Tools iránt érdeklődhet a közösség, de az Ön kreativitása mindig felülmúlja elvárásainkat. Tehát ezek az irányelvek valószínűleg idővel változni fognak, ahogy a TM Tools program bővül, és elkezdjük látni, hogy mi lesz belőle!
  • Emlékeztetőül: a jogosulatlan vagy illegálisan módosított szoftverek (azaz olyan szoftverek, amelyek megsértik a jelen irányelvek bármelyikét) hivatalos kvalifikációs versenyen történő használata tilos.