TM viešoji API

• API yra taisyklių ir įrankių rinkinys, leidžiantis skirtingoms programinės įrangos programoms bendrauti tarpusavyje. TM Public API tikslas yra suteikti oficialiai pripažintą galimybę pažengusiems VEX bendruomenės nariams sukurti savo turnyrų vadybininko „plėtimus“ arba „priedus“.
• Skatinamų / leidžiamų integracijų pavyzdžiai:
  • Automatiškai įrašyti ir (arba) įkelti atskiras varžybų rungtynes
  • Vaizdo įrašų perjungiklio valdymas, norint pasirinkti kamerą, susietą su aktyviu lauku
  • Pridedamas makropadės palaikymas
  • PTZ kameros valdymas, nukreipiantis į aktyvų lauką
  • Automatiškai perjungiamas auditorijos ekrano pasirinkimas pagal įvairias sąlygas
  • Padaryti komiškai didelį mygtuką „pradėti rungtynes“.
• TM viešoji API yra pradiniame etape ir teikiama tokia, kokia yra, be jokios garantijos. Nors tikimės išlaikyti suderinamumą ir ateityje, pasiliekame teisę bet kuriuo metu keisti arba nutraukti API.

Kokios funkcijos yra?

• Rungtynių tvarkaraštis / rezultatai
• Reitingai
• Įgūdžių rezultatai
• Įvykių srautas (pvz., momentas, kai rungtynės patenka į laukų eilę, rungtynių pradžia ir pan.)
• Pagrindinės atitikties valdymo komandos (pvz., paleisti/sustabdyti, į eilę kitą atitiktį)

Kokios funkcijos NĖRA?

• Viskas, kas susiję su „rašyti“ ar „redaguoti“.
• Redaguoti arba pateikti balus
• Informacija realiuoju laiku rungtynių metu (pvz., tiesioginiai įvarčiai)
• Komandos informacijos redagavimas
• Įvykių konfigūracijos keitimas (pvz., laukų rinkiniai, rungtynių tvarkaraščių generavimas ir kt.)

Esu renginio partneris; kaip įjungti API, jei renginyje noriu naudoti trečiųjų šalių įrankius?

• Atidarykite Tournament Manager ir pasirinkite meniu Įrankiai, tada Parinktys. Atsidarius langui Parinktys, pasirinkite kategoriją Interneto publikavimas. Pažymėkite žymimąjį laukelį „Įgalinti vietinę TM API“ ir išsaugokite pakeitimus.
• Tai reikės padaryti kiekvieną kartą, kai sukuriamas naujas įvykis.

Aš esu kūrėjas; kaip pradėti kurti naudojant TM API?

• Daugiau informacijos rasite Turnyrų vadybininko viešajame API vadove.
• Norėdami pradėti, pateikite API kredencialų užklausą naudodami šią nuorodą ir papasakokite apie tai, ką dirbate. Nesijaudink; tol, kol jūsų numatyta paraiška atitinka toliau išvardytas gaires, ji turėtų būti patvirtinta. Tai padės įsitikinti, kad neskiriate vystymosi energijos tam, kas vėliau bus neleidžiama!

Taisyklės & Nuostatai

• Trečiųjų šalių programos turi atitikti visus techninius reikalavimus, išvardytus TM viešajame API vadove (pvz., užklausos pasirašymas, programos ID, API raktai ir kt.)
• Turi būti reikalaujama, kad vartotojas rankiniu būdu „pasirinktų“ arba rankiniu būdu įgalintų priedą per Įrankiai > Nustatymai > Žiniatinklio publikavimas“ > „Įgalinti vietinės TM API“.
• Beta API gali būti techniškai įmanomi toliau nurodyti dalykai, tačiau jie yra aiškiai draudžiami. Programos, kurios pažeidžia šias gaires, bus išjungtos, o jų API kredencialai bus atšaukti.
  • Rodyti bet kokio tipo atitikties laikąarba keisti bet ką, susijusį su rungtynių laiku, išskyrus informaciją, esančią API įvykių sraute.
    • Tikslaus laiko laikymas ir teisingas jo sinchronizavimas visuose įmanomuose įrenginiuose yra stebėtinai sudėtingas iššūkis, susipynęs daugelyje pagrindinės TM kodų bazės dalių.
    • Neįmanoma nuspėti, kokių nenumatytų pasekmių gali kilti suteikus prieigą prie šio per viešai prieinamą API, ir nenorime, kad EP ir komandos būtų tokioje padėtyje, kurioje jie nebūtų tikri, ar gali pasitikėti laiku, rodomu jų ekranai.
  • Atkurti bet kokias esamas funkcijas (pvz., sukurti savo „TM Mobile“)
    • Nuoseklios pagrindinės renginių patirties palaikymas yra pagrindinis REC fondo renginių modelio principas. Komandos turėtų galėti pasitikėti, kad pagrindiniai jų renginyje naudojami įrankiai yra tokie patys kaip ir bet kur kitur, ir kad savanoriai, turintys patirties viename renginyje, gali peršokti į kitą renginį su minimaliomis treniruotėmis – nesvarbu, ar tai būtų mažiausios lygos renginys, ar didžiausias parašo renginys!
    • Jei turite idėjų, kaip būtų galima patobulinti esamą funkciją, praneškite mums tiesiogiai! Pakeitimai, kurie tikrai suteikia geresnę vartotojo patirtį, turėtų būti įrašyti tiesiogiai į TM ir pasiekiami visiems įvykiams.
  • Keičiant arba iš naujo sukuriant bet kokią auditoriją, rodoma
    • Be aukščiau paminėtų nuoseklumo pastabų, į oficialius auditorijos ekranus įtrauktas turinys yra REC fondo rėmėjų, pritaikymo neįgaliesiems grupių ir rinkodaros / prekės ženklo valdymo komandų kritinio dizaino & tikrinimo procesų rezultatas.
    • Nors ekrano pakeitimai gali atrodyti nekalti vieno įvykio kontekste, jie dažnai gali turėti nenumatytų pasekmių, kurios paveiks REC fondą didesniu mastu (pvz., rėmimo sutartys arba autorių teisių saugomo vaizdo naudojimo apribojimai).
  • Prieiga prie bet kokių vidinių „Tournament Manager komponentų arba jų keitimas ne oficialiuose atviruose API protokoluose
    • Trečiųjų šalių modifikacijos, sukurtos neoficialiai, gali pakenkti įvykių vientisumui. Oficialūs API įėjimo taškai buvo sąmoningai sukurti kaip žinomas būdas trečiųjų šalių plėtiniams, kurie sumažina arba pašalina šią riziką.
    • Modifikacijos už šių kanalų ribų, be šių gairių pažeidimo, gali pakenkti EP ar komandoms tokioje padėtyje, kai jos negali pasitikėti renginį vykdančia programine įranga.
• Pastaba: tai ir mums neištirta teritorija! Galbūt turime idėjų, kokiais TM įrankiais gali dominti bendruomenė, tačiau jūsų kūrybiškumas nenustoja viršyti mūsų lūkesčių. Taigi, šios gairės laikui bėgant greičiausiai tobulės, nes TM Tools programa plečiasi ir pradėsime matyti, kas iš jos gaunama!
• Primename, kad bet koks neteisėtos arba neteisėtai modifikuotos programinės įrangos (ty programinės įrangos, kuri pažeidžia bet kurią iš šių gairių) naudojimas oficialiame kvalifikaciniame renginyje yra draudžiamas.
  • Dėl to kūrėjams bus atšaukti API kredencialai ir išjungtos programos.
  • Studentams ar kitiems komandos nariams tai bus traktuojama kaip REC fondo elgesio kodeksopažeidimas.
  • Renginio partneriams tai bus traktuojama kaip įsipareigojimo dėl renginio tobulumopažeidimas.