1. RECF Kirjasto
  2. Tapahtuman yhteistyökumppanit
  3. Juoksutapahtumat
  4. Tournament Manager -ohjelmiston käyttäminen

TM Public API

Tournament Managerin (TM) julkisen API:n avulla kolmannen osapuolen kehittäjät voivat rakentaa työkaluja ja integraatioita, jotka toimivat Tournament Manager -ohjelmiston kanssa. Tietyntyyppiset integraatiot (esim. video- tai näyttökytkimet) ovat sallittuja ja toiset (esim. vaihtoehtoiset otteluajastimen näytöt) ovat kiellettyjä. Tämä artikkeli sisältää yleiskatsauksen TM Public API:sta ja linkin kattavampiin tietoihin.

Mikä on TM Public API?

  • API on joukko sääntöjä ja työkaluja, joiden avulla eri ohjelmistosovellukset voivat kommunikoida keskenään. TM Public API:n tavoitteena on tarjota virallisesti tunnustettu mahdollisuus VEX-yhteisön edistyneille jäsenille kehittää omia Tournament Managerin "laajennuksia" tai "lisäosia".
  • Esimerkkejä suositelluista/sallituista integroinneista ovat:
    • Tallentaa ja/tai lataa automaattisesti yksittäisiä kilpailuotteluita
    • Ohjaa videokytkintä aktiiviseen kenttään liittyvän kameran valitsemiseksi
    • Macropad-tuen lisääminen
    • PTZ-kameran ohjaaminen osoittamaan aktiivista kenttää
    • Yleisön näyttöruudun valinnan vaihtaminen automaattisesti eri olosuhteiden perusteella
    • Koomisen suuren "aloita ottelu" -painike
  • TM Public API on alkuvaiheessa, ja se toimitetaan "sellaisenaan" ilman minkäänlaista takuuta. Vaikka toivommekin säilyttävämme yhteensopivuuden tulevaisuudessa, pidätämme oikeuden muokata API:ta tai lopettaa sen käytön milloin tahansa.

Mitä toimintoa on saatavilla?

  • Otteluohjelma / tulokset
  • Rankingissa
  • Taitojen tulokset
  • Tapahtumavirta (esim. hetki, jolloin ottelut ovat jonossa kenttiin, ottelut alkavat jne.)
  • Perusosuuksien ohjauskomennot (esim. aloitus/lopetus, jonoon seuraava ottelu)

Mitä toimintoa EI ole saatavilla?

  • Mikä tahansa "kirjoita" tai "muokkaa" liittyvä
  • Pisteiden muokkaaminen tai lähettäminen
  • Reaaliaikaiset tiedot ottelun aikana (esim. live-pisteet)
  • Ryhmätietojen muokkaaminen
  • Tapahtumamääritysten muuttaminen (esim. kenttäjoukot, otteluaikataulujen luominen jne.)

Olen tapahtumakumppani; kuinka otan API käyttöön, jos haluan käyttää tapahtumassani kolmannen osapuolen työkaluja?

  • Avaa Tournament Manager ja valitse Työkalut-valikko ja sitten Asetukset. Kun Asetukset-ikkuna avautuu, valitse Web Publishing -luokka. Valitse Enable Local TM API -valintaruutu ja tallenna muutokset.
  • Tämä on tehtävä aina, kun uusi tapahtuma luodaan.

Olen kehittäjä; kuinka aloitan kehittämisen TM API:lla?

  • Lisätietoja on Tournament Manager Public API Guidessa.
  • Aloita lähettämällä API-tunnistepyyntö tästä linkistä ja kertomalla meille, mitä olet tekemässä. Älä huoli; niin kauan kuin suunnittelemasi hakemuksesi on alla lueteltujen ohjeiden mukainen, se tulee hyväksyä. Tämä auttaa varmistamaan, että et laita kehitysenergiaa johonkin, joka ei päätyisi myöhemmin olemaan sallittua!

Säännöt & Säännöt

  • Kolmannen osapuolen sovellusten on noudatettava kaikkia TM Public API Guidessa lueteltuja teknisiä vaatimuksia (esim. pyynnön allekirjoitus, sovellustunnus, API-avaimet jne.)
  • Käyttäjää on vaadittava manuaalisesti "opt-in" tai ottamaan lisäosa manuaalisesti käyttöön työkalujen > Asetukset > Web Publishing > "Ota paikallinen TM API käyttöön" kautta.
  • Seuraavat asiat voivat olla teknisesti mahdollisia beta-sovellusliittymässä, mutta ne ovat nimenomaisesti kiellettyjä. Sovellukset, jotka rikkovat näitä ohjeita, poistetaan käytöstä ja niiden API-tunnistetiedot peruutetaan.
    • Näytä minkä tahansa tyyppinen otteluaikatai muokkaa mitään, joka liittyy otteluaikaan, lukuun ottamatta sovellusliittymän tapahtumavirtaan sisältyviä tietoja.
      • Tarkan ajan pitäminen ja sen oikea synkronointi kaikkien mahdollisten laitteiden välillä on yllättävän monimutkainen haaste, joka on kietoutunut moniin TM-ytimen koodikannan osiin.
      • On mahdotonta ennustaa, mitä ei-toivottuja seurauksia voi aiheutua pääsystä tähän julkisen sovellusliittymän kautta, emmekä halua asettaa EP:itä ja tiimejä tilanteeseen, jossa he eivät ole varmoja, voivatko he luottaa näytössä näkyvään aikaan. niiden näytöt.
    • Luoda uudelleen kaikki olemassa olevat toiminnot (esim. tekemällä oma "TM Mobile")
      • Johdonmukaisen ydintapahtumakokemuksen ylläpitäminen on REC Foundation -tapahtumamallin perusperiaate. Joukkueiden tulee voida luottaa siihen, että heidän tapahtumassaan käytettävät perustyökalut ovat samat kuin missä tahansa muuallakin ja että vapaaehtoiset, joilla on kokemusta yhdestä tapahtumasta, voivat hypätä toiseen tapahtumaan vähäisellä koulutuksella – olipa kyseessä sitten pienin liigatapahtuma tai suurin allekirjoitustapahtuma!
      • Jos sinulla on ideoita olemassa olevan toiminnon parantamiseksi, kerro siitä meille suoraan! Muutokset, jotka todella tarjoavat paremman käyttökokemuksen, tulee kirjoittaa suoraan TM:ään ja kaikkien tapahtumien käytettävissä.
    • yleisön muokkaaminen tai luominen uudelleen näyttää
      • Yllä mainittujen johdonmukaisuushuomautusten lisäksi virallisten yleisönäyttöjen sisältö on tulosta REC Foundationin sponsorien, esteettömyysryhmien ja markkinoinnin/brändin hallintatiimien välisistä & suunnitteluprosesseista.
      • Vaikka näytön muutokset saattavat vaikuttaa viattomalta yksittäisen tapahtuman yhteydessä, niillä voi usein olla tahattomia seurauksia, jotka vaikuttavat REC-säätiöön laajemmassa mittakaavassa (esim. sponsorointisopimukset tai tekijänoikeudella suojatun kuvan käytön rajoitukset).
    • Tournament Manager n sisäisten komponenttien käyttö tai muokkaaminen virallisten avointen API-protokollienulkopuolella
      • Kolmannen osapuolen tekemät muutokset, jos ne on luotu epävirallisesti, voivat vaarantaa tapahtuman eheyden. Viralliset API-sisääntulokohdat on tarkoituksella luotu tunnetuksi kolmansien osapuolien laajennuksille, jotka minimoivat tai eliminoivat tämän riskin.
      • Näiden kanavien ulkopuoliset muutokset voivat sen lisäksi, että ne rikkovat näitä ohjeita, saattavat asettaa EP:t tai tiimit tilanteeseen, jossa he eivät voi luottaa tapahtumaansa suorittavaan ohjelmistoon.
  • Huomaa: Tämä on tutkimaton alue myös meille! Meillä saattaa olla ideoita siitä, mistä TM-työkaluista yhteisö voi olla kiinnostunut, mutta luovuutesi ei koskaan lakkaa ylittämästä odotuksiamme. Nämä ohjeet todennäköisesti kehittyvät ajan myötä, kun TM Tools -ohjelma laajenee ja alamme nähdä, mitä siitä tulee!
  • Muistutuksena on, että luvattomien tai laittomasti muokatun ohjelmiston (eli ohjelmiston, joka rikkoo jotakin näistä ohjeista) käyttö virallisessa karsintatapahtumassa on kielletty.