TM Public API

• API je sada pravidel a nástrojů, které umožňují různým softwarovým aplikacím vzájemně komunikovat. Cílem TM Public API je poskytnout oficiálně uznávanou příležitost pro pokročilé členy komunity VEX vyvinout vlastní „rozšíření“ nebo „doplňky“ pro Tournament Manager.
• Příklady podporovaných/povolených integrací zahrnují:
  • Automatické nahrávání a/nebo nahrávání jednotlivých soutěžních zápasů
  • Ovládání přepínače videa pro výběr kamery spojené s aktivním polem
  • Přidání podpory makropadu
  • Ovládání PTZ kamery tak, aby ukazovala na aktivní pole
  • Automatické přepínání výběru obrazovky publika na základě různých podmínek
  • Vytvoření komicky velkého tlačítka „zahájit zápas“.
• TM Public API je ve své rané fázi a je poskytováno „tak jak je“ bez jakékoli záruky. I když doufáme, že kompatibilitu zachováme i v budoucnu, vyhrazujeme si právo API kdykoli upravit nebo ukončit.

Jaká funkce je k dispozici?

• Rozpis zápasů / výsledky
• Žebříčky
• Výsledky dovedností
• Stream událostí (např. okamžik, kdy jsou zápasy zařazeny do fronty na hřiště, začátek zápasu atd.)
• Základní příkazy pro ovládání zápasu (např. start/stop, fronta na další zápas)

Jaká funkce NENÍ dostupná?

• Cokoli souvisejícího s „psáním“ nebo „úpravou“.
• Úpravy nebo odesílání skóre
• Informace v reálném čase během zápasu (např. živé skóre)
• Úprava informací o týmu
• Úprava konfigurace události (např. sady polí, generování rozpisů zápasů atd.)

Jsem partnerem akce; jak povolím rozhraní API, pokud chci na své akci používat nástroje třetích stran?

• Otevřete Správce turnajů a vyberte nabídku Nástroje a poté Možnosti. Když se otevře okno Možnosti, vyberte kategorii Web Publishing. Zaškrtněte políčko „Enable Local TM API“ a uložte změny.
• To bude nutné provést pokaždé, když se vytvoří nová událost.

Jsem vývojář; jak začnu vyvíjet s TM API?

• Více informací naleznete v Tournament Manager Public API Guide.
• Chcete-li začít, odešlete žádost o pověření API na tomto odkazu a řekněte nám, na čem pracujete. Nebojte se; pokud vaše zamýšlená žádost spadá do níže uvedených pokynů, měla by být schválena. To vám pomůže zajistit, že nevkládáte vývojovou energii do něčeho, co později nebude povoleno!

Pravidla & Předpisy

• Aplikace třetích stran musí splňovat všechny technické požadavky uvedené v TM Public API Guide (např. podepisování požadavků, ID aplikace, klíče API atd.)
• Musí vyžadovat, aby uživatel ručně „přihlásil“ nebo ručně aktivoval doplněk pomocí Nástroje > Nastavení > Publikování na webu > „Povolit Local TM API“.
• Následující věci mohou být v beta rozhraní API technicky možné, ale Aplikace, u kterých bude zjištěno, že porušují tyto pokyny, budou deaktivovány a budou jim odebrány přihlašovací údaje k rozhraní API.
  • Zobrazení libovolného typu času shodynebo úprava čehokoli souvisejícího s časem shody, kromě informací obsažených ve streamu událostí rozhraní API.
    • Udržování přesného času a jeho správná synchronizace napříč všemi možnými zařízeními je překvapivě složitá výzva, která se prolíná v mnoha částech základní kódové základny TM.
    • Je nemožné předvídat, jaké nezamýšlené důsledky může mít poskytnutí přístupu k tomuto prostřednictvím veřejně přístupného API, a nechceme dostat EP a týmy do pozice, kdy si nebudou jisti, zda mohou věřit času, který je zobrazen na jejich obrazovky.
  • Obnovení jakékoli stávající funkce (např. vytvoření vlastního „TM Mobile“)
    • Udržování konzistentního základního zážitku z událostí je základní zásadou modelu událostí REC Foundation. Týmy by měly být schopny důvěřovat tomu, že základní nástroje používané na jejich akci jsou stejné jako ty, které se používají kdekoli jinde, a že dobrovolníci se zkušenostmi z jedné akce mohou skočit na jinou akci s minimálním tréninkem – ať už jde o nejmenší ligovou akci nebo největší podpisová událost!
    • Pokud máte nápady, jak by bylo možné stávající funkci vylepšit, dejte nám vědět přímo! Změny, které skutečně poskytují lepší uživatelskou zkušenost, by měly být zapsány přímo do TM a dostupné všem událostem.
  • Úprava nebo opětovné vytvoření libovolného zobrazení publika
    • Kromě výše uvedených poznámek o konzistenci je obsah obsažený v oficiálních publikacích výsledkem & procesů prověřování designu mezi sponzory REC Foundation, skupinami pro dostupnost a marketingovými/značkovými týmy.
    • I když se úpravy zobrazení mohou zdát nevinné v kontextu jedné události, mohou mít často nezamýšlené důsledky, které mají dopad na REC Foundation ve větším měřítku (např. sponzorské smlouvy nebo omezení použití obrázku chráněného autorským právem).
  • Přístup nebo úprava jakýchkoli interních komponent Tournament Manager mimo oficiální otevřené protokoly API
    • Úpravy třetích stran, pokud jsou vytvořeny neoficiálně, představují potenciální riziko ohrožení integrity události. Oficiální vstupní body API byly záměrně vytvořeny jako známá cesta pro rozšíření třetích stran, která toto riziko minimalizuje nebo eliminuje.
    • Úpravy mimo tyto kanály, kromě porušení těchto pokynů, mohou představovat riziko, že EP nebo týmy se dostanou do pozice, kdy nemohou důvěřovat softwaru, který jejich událost provozuje.
• Poznámka: Toto je pro nás také neprobádané území! Můžeme mít nějaké nápady, jaké nástroje TM by komunitu mohly zajímat, ale vaše kreativita nikdy nepřestane překonávat naše očekávání. Tyto pokyny se tedy pravděpodobně časem vyvinou, jak se bude program TM Tools rozšiřovat a my začneme zjišťovat, co z toho plyne!
• Připomínáme, že jakékoli použití neautorizovaného nebo nezákonně upraveného softwaru (tj. softwaru, který porušuje kteroukoli z těchto pokynů) v oficiální kvalifikační soutěži je zakázáno.
  • Pro vývojáře to bude mít za následek zrušení jejich pověření API a deaktivaci jejich aplikací.
  • Pro studenty nebo jiné členy týmu to bude považováno za porušení REC Foundation Code of Conduct.
  • U partnerů akce to bude považováno za porušení Závazku k dokonalosti akce.