Turnīra pārvaldnieka (TM) publiskā API ļauj trešo pušu izstrādātājiem izveidot rīkus un integrācijas, kas sadarbojas ar Tournament Manager programmatūru. Daži integrācijas veidi (piemēram, video vai displeja pārslēdzēji) ir atļauti, bet citi (piemēram, alternatīvi atbilstības taimera displeji) ir aizliegti. Šajā rakstā ir sniegts pārskats par TM publisko API un saite uz plašāku informāciju.

Kas ir TM publiskā API?

  •  API ir noteikumu un rīku kopums, kas ļauj dažādām programmatūras lietojumprogrammām sazināties savā starpā. TM Public API mērķis ir nodrošināt oficiāli atzītu iespēju pieredzējušiem VEX kopienas dalībniekiem izstrādāt savus turnīru pārvaldnieka “paplašinājumus” vai “papildinājumus”.
  • Ieteicamās/atļautās integrācijas piemēri:
    • Automātiski ierakstīt un/vai augšupielādēt atsevišķas sacensību spēles
    • Video pārslēdzēja vadīšana, lai atlasītu kameru, kas saistīta ar aktīvo lauku
    • Macropad atbalsta pievienošana
    • PTZ kameras vadīšana, lai norādītu uz aktīvo lauku
    • Automātiska auditorijas displeja ekrāna atlases pārslēgšana, pamatojoties uz dažādiem apstākļiem
    • Komiski lielas pogas “sākt maču” izveidošana
  • TM Public API ir agrīnā stadijā, un tā tiek nodrošināta “tāda, kāda ir” bez jebkādas garantijas. Lai gan mēs ceram saglabāt saderību arī turpmāk, mēs paturam tiesības jebkurā laikā mainīt vai pārtraukt API.

Kāda ir pieejama?

  • Spēļu grafiks / rezultāti
  • Reitingi
  • Prasmju rezultāti
  • Notikumu straume (piemēram, brīdis, kad spēles tiek saliktas rindā uz laukiem, spēles sākas utt.)
  • Pamata atbilstības kontroles komandas (piem., start/stop, rinda nākamo spēli)

Kāda funkcionalitāte NAV pieejama?

  • Viss, kas saistīts ar “rakstīt” vai “rediģēt”.
  • Rezultātu rediģēšana vai iesniegšana
  • Reāllaika informācija spēles laikā (piemēram, tiešraides rezultāti)
  • Rediģēt komandas informāciju
  • Notikumu konfigurācijas mainīšana (piemēram, lauku kopas, spēļu grafiku ģenerēšana utt.)

Esmu pasākuma partneris; kā iespējot API, ja savā pasākumā vēlos izmantot trešās puses rīkus?

  • Atveriet Tournament Manager un atlasiet izvēlni Rīki un pēc tam Opcijas. Kad tiek atvērts logs Opcijas, atlasiet kategoriju Web Publishing. Atzīmējiet izvēles rūtiņu “Iespējot vietējo TM API” un saglabājiet izmaiņas.
  • Tas būs jādara katru reizi, kad tiek izveidots jauns pasākums.

Es esmu izstrādātājs; kā sākt izstrādāt ar TM API?

  • Vairāk informācijas var atrast Tournament Manager Public API Guide.
  • Lai sāktu, iesniedziet API akreditācijas datu pieprasījumu izmantojot šo saiti un pastāstiet mums, pie kā strādājat. Neuztraucieties; kamēr jūsu paredzētais pieteikums atbilst tālāk norādītajām vadlīnijām, tas ir jāapstiprina. Tas palīdzēs pārliecināties, ka jūs neliekat attīstības enerģiju kaut kam, kas vēlāk netiks atļauts!

Noteikumi & Noteikumi

  • Trešo pušu lietojumprogrammām ir jāatbilst visām tehniskajām prasībām, kas norādītas TM publiskā API rokasgrāmatā (piemēram, pieprasījuma parakstīšana, lietotnes ID, API atslēgas utt.).
  • Jāpieprasa lietotājam manuāli “izvēlēties” vai manuāli iespējot pievienojumprogrammu, izmantojot Rīki > Iestatījumi > Tīmekļa publicēšana > “Iespējot vietējo TM API”.
  • Tālāk norādītās lietas var būt tehniski iespējamas beta API, taču tās ir nepārprotami aizliegtas. Lietojumprogrammas, kas pārkāpj šīs vadlīnijas, tiks atspējotas, un tām tiks atsaukti API akreditācijas dati.
    • Jebkāda veida  atbilstības laikarādīšana vai jebkāda ar spēles laiku saistīta visa veida modificēšana, izņemot informāciju, kas ietverta API notikumu straumē.
      • Precīza laika saglabāšana un pareiza tā sinhronizēšana visās iespējamajās ierīcēs ir pārsteidzoši sarežģīts izaicinājums, kas ir savijies daudzās galvenās TM kodu bāzes daļās.
      • Nav iespējams paredzēt, kādas neparedzētas sekas var rasties, nodrošinot piekļuvi šim, izmantojot publiski pieejamu API, un mēs nevēlamies nostādīt EP un komandas tādā stāvoklī, ka viņi nav pārliecināti, vai var uzticēties ekrānā redzamajam laikam. viņu ekrāni.
    •  Atkārtoti izveidojiet jebkuru esošo funkcionalitāti (piemēram, izveidojiet savu "TM Mobile")
      • REC Foundation pasākumu modeļa pamatprincips ir konsekventas galvenās pasākumu pieredzes uzturēšana. Komandām jāspēj paļauties, ka viņu pasākumā izmantotie pamatrīki ir tādi paši kā tie, kas tiek izmantoti jebkur citur, un ka brīvprātīgie ar pieredzi vienā pasākumā var pāriet uz citu pasākumu ar minimālu apmācību — neatkarīgi no tā, vai tas ir mazākās līgas pasākums vai lielākais parakstu pasākums!
      • Ja jums ir idejas, kā esošu funkciju varētu uzlabot, ziņojiet mums tieši! Izmaiņas, kas patiešām nodrošina labāku lietotāja pieredzi, ir jāieraksta tieši TM un ir pieejamas visiem notikumiem.
    • Pārveidojot vai izveidojot no jauna jebkuras  mērķauditorijas displejus
      • Papildus iepriekš minētajām konsekvences piezīmēm saturs, kas iekļauts oficiālajā auditorijas displejā, ir REC Foundation sponsoru, pieejamības grupu un mārketinga/zīmola vadības komandu kritisko dizaina & pārbaudes procesu rezultāts.
      • Lai gan displeja modifikācijas var šķist nevainīgas viena notikuma kontekstā, tām bieži var būt neparedzētas sekas, kas ietekmē REC fondu plašākā mērogā (piemēram, sponsorēšanas līgumi vai ar autortiesībām aizsargāta attēla izmantošanas ierobežojumi).
    • Piekļuve jebkādiem Tournament Manager iekšējiem komponentiem vai to modificēšana ārpus oficiālajiem atvērtajiem API protokoliem
      • Trešās puses modifikācijas, ja tās ir izveidotas neoficiāli, rada iespējamu risku apdraudēt notikumu integritāti. Oficiālie API ieejas punkti ir apzināti izveidoti kā zināms veids trešo pušu paplašinājumiem, kas samazina vai novērš šo risku.
      • Izmaiņas ārpus šiem kanāliem, papildus šo vadlīniju pārkāpumam, var radīt EP vai komandas situācijā, kad tās nevar uzticēties programmatūrai, kas vada viņu pasākumu.
  • Piezīme: arī mums šī ir neizpētīta teritorija! Mums var būt dažas idejas par to, kādi TM rīki varētu interesēt sabiedrību, taču jūsu radošums nebeidz pārspēt mūsu cerības. Tātad šīs vadlīnijas laika gaitā, visticamāk, attīstīsies, TM Tools programmai paplašinās un mēs sāksim redzēt, kas no tās izriet!
  • Atgādinām, ka jebkāda neatļautas vai nelikumīgi modificētas programmatūras (ti, programmatūras, kas pārkāpj kādu no šīm vadlīnijām) izmantošana oficiālā kvalifikācijas pasākumā ir aizliegta.