TM Public API

Tournament Manager (TM) Public API үшінші тарап әзірлеушілеріне Tournament Manager бағдарламалық құралымен өзара әрекеттесетін құралдар мен интеграцияларды құруға мүмкіндік береді. Біріктірудің кейбір түрлеріне (мысалы, бейне немесе дисплей ауыстырғыштары) рұқсат етіледі, ал басқаларына (мысалы, сәйкестік таймерінің балама дисплейлері) тыйым салынады. Бұл мақалада TM Public API шолуы және толық ақпаратқа сілтеме берілген.

TM Public API дегеніміз не?

• API - әртүрлі бағдарламалық жасақтама қолданбаларының бір-бірімен байланысуына мүмкіндік беретін ережелер мен құралдар жиынтығы. TM Public API мақсаты VEX қауымдастығының озық мүшелеріне өздерінің турнир менеджерінің «кеңейтімдерін» немесе «қондырмаларын» әзірлеу үшін ресми түрде танылған мүмкіндікті қамтамасыз ету болып табылады.
• Ынталандыру/рұқсат етілген интеграция мысалдарына мыналар жатады:
  • Жеке жарыс матчтарын автоматты түрде жазу және/немесе жүктеп салу
  • Белсенді өріспен байланысты камераны таңдау үшін бейне ауыстырғышты басқару
  • Макропад қолдауын қосу
  • Белсенді өрісті көрсету үшін PTZ камерасын басқару
  • Түрлі шарттарға негізделген аудитория дисплей экранының таңдауын автоматты түрде ауыстыру
  • Күлкілі үлкен «сәйкестікті бастау» түймесін жасау
• TM Public API өзінің бастапқы кезеңдерінде және кез келген түрдегі кепілдіксіз «сол қалпында» беріледі. Болашақта үйлесімділікті сақтаймыз деп үміттенсек те, API интерфейсін кез келген уақытта өзгерту немесе тоқтату құқығын сақтаймыз.

Қандай функция қол жетімді?

• Матч кестесі/нәтижелері
• Рейтингтер
• Дағдылардың нәтижелері
• Оқиғалар ағыны (мысалы, матчтардың өрістерге кезекке қойылған сәті, матчтың басталу уақыты, т.б.)
• Негізгі сәйкестікті басқару пәрмендері (мысалы, бастау/тоқтату, келесі сәйкестікті кезекке қою)

қандай функция ЕМЕС?

• Кез келген «жазу» немесе «өңдеу» байланысты
• Ұпайларды өңдеу немесе жіберу
• Матч кезіндегі нақты уақыттағы ақпарат (мысалы, тікелей есеп)
• Топ туралы ақпаратты өңдеу
• Оқиға конфигурациясын өзгерту (мысалы, өрістер жиындары, сәйкестік кестелерін жасау, т.б.)

Мен іс-шараның серіктесімін; іс-шарада үшінші тарап құралдарын пайдаланғым келсе, API қалай қосуға болады?

• Турнир менеджерін ашып, Құралдар мәзірін, содан кейін Параметрлерді таңдаңыз. Параметрлер терезесі ашылғанда, Web Publishing санатын таңдаңыз. «Local TM API қосу» құсбелгісін қойып, өзгертулерді сақтаңыз.
• Бұл жаңа оқиға жасалған сайын жасалуы керек.

Мен әзірлеушімін; TM API арқылы әзірлеуді қалай бастауға болады?

• Қосымша ақпаратты Tournament Manager Public API Guideбөлімінен табуға болады.
• Бастау үшін API тіркелгі деректері сұрауын осы сілтеме арқылы жіберіңіз және не істеп жатқаныңызды айтыңыз. Уайымдама; сіздің болжанған өтінішіңіз төменде көрсетілген нұсқауларға сәйкес келетін болса, ол мақұлдануы керек. Бұл даму энергиясын кейінірек рұқсат етілмейтін нәрсеге жұмсамайтыныңызға көз жеткізуге көмектеседі!

Ережелер & Ереже

• Үшінші тарап қолданбалары TM Public API нұсқаулығында тізімделген барлық техникалық талаптарды орындауы керек (мысалы, сұрауға қол қою, қолданба идентификаторы, API кілттері, т.б.)
• Пайдаланушыдан Құралдар > Параметрлер > Web Publishing > «Жергілікті TM API қосу» арқылы қолмен «қосуды» немесе қондырманы қолмен қосуды талап етуі керек.
• Келесі нәрселер бета API-де техникалық мүмкін болуы мүмкін, бірақ анық тыйым салынған. Осы нұсқауларды бұзған қолданбалар өшіріледі және олардың API тіркелгі деректері қайтарып алынады.
  • API оқиға ағынында қамтылған ақпараттан басқа сәйкестік уақытытүрінің кез келген түрін көрсету немесе сәйкестік уақытына қатысты кез келген нәрсені өзгерту.
    • Дәл уақытты сақтау және оны барлық ықтимал құрылғыларда дұрыс синхрондау - TM негізгі кодтық базасының көптеген бөліктерінде біріктірілген таңқаларлық күрделі мәселе.
    • Жалпыға қолжетімді API арқылы бұған қол жеткізуді қамтамасыз етудің күтпеген салдары қандай болуы мүмкін екенін болжау мүмкін емес, және біз БӨ мен командаларды олар көрсетілетін уақытқа сене алатындығына сенімді емес жағдайға қойғымыз келмейді. олардың экрандары.
  • бар кез келген функционалдылықты қайта жасау (мысалы, жеке «TM Mobile» жасау)
    • Оқиғаның дәйекті тәжірибесін сақтау REC Foundation оқиға үлгісінің негізгі қағидасы болып табылады. Командалар өз іс-шарасында қолданылатын негізгі құралдардың басқа жерде қолданылатын құралдармен бірдей екеніне және бір іс-шарада тәжірибесі бар волонтерлердің басқа іс-шараға минималды дайындықпен - бұл лиганың ең кіші оқиғасы немесе ең кішкентай оқиғасы болсын, өтуі мүмкін екеніне сенімді болуы керек ең үлкен қол қою оқиғасы!
    • Қолданыстағы функцияны қалай жақсартуға болатыны туралы идеяларыңыз болса, бізге тікелей хабарлаңыз! Жақсырақ пайдаланушы тәжірибесін шынымен қамтамасыз ететін өзгерістер TM-ге тікелей жазылуы және барлық оқиғаларға қолжетімді болуы керек.
  • Кез келген аудитория дисплейін өзгерту немесе қайта жасау
    • Жоғарыда аталған жүйелілік ескертпелеріне қоса, ресми аудитория дисплейлеріне енгізілген мазмұн REC Foundation демеушілері, қолжетімділік топтары және маркетинг/брендті басқару топтары арасындағы сыни дизайн & тексеру процестерінің нәтижесі болып табылады.
    • Дисплейді өзгертулер бір оқиғаның контекстінде кінәсіз болып көрінуі мүмкін болса да, олар көбінесе REC қорына ауқымды түрде әсер ететін күтпеген салдарға әкелуі мүмкін (мысалы, демеушілік келісімдер немесе авторлық құқықпен қорғалған кескінді пайдалануға шектеулер).
  • Ресми ашық API протоколдарынан тыс Tournament Manager кез келген ішкі құрамдастарына қол жеткізу немесе өзгерту
    • Бейресми түрде жасалған үшінші тарап өзгертулері оқиғаның тұтастығын бұзудың ықтимал қаупін тудырады. Ресми API кіру нүктелері осы тәуекелді азайтатын немесе жоятын үшінші тарап кеңейтімдері үшін белгілі жол ретінде әдейі жасалған.
    • Осы арналардан тыс өзгертулер осы нұсқауларды бұзумен қатар, БӨ немесе командаларды оқиғаны іске асыратын бағдарламалық құралға сенбейтін жағдайға қою қаупін тудыруы мүмкін.
• Ескерту: Бұл біз үшін де зерттелмеген аумақ! Бізде қауымдастықты қызықтыратын TM құралдары туралы кейбір идеялар болуы мүмкін, бірақ сіздің шығармашылық қабілеттеріңіз ешқашан күткенімізден асып түсуді тоқтатпайды. Осылайша, бұл нұсқаулар TM Tools бағдарламасы кеңейген сайын уақыт өте келе дамиды және біз одан не шығатынын көре бастаймыз!
• Еске сала кетейік, рұқсат етілмеген немесе заңсыз өзгертілген бағдарламалық құралды (яғни, осы нұсқаулардың кез келгенін бұзатын бағдарламалық құралды) ресми біліктілік іс-шарасында пайдалануға қатаң тыйым салынады.
  • Әзірлеушілер үшін бұл олардың API тіркелгі деректерінің жойылуына және қолданбаларының өшірілуіне әкеледі.
  • Студенттер немесе басқа топ мүшелері үшін бұл REC Foundationмінез-құлық кодексін бұзу ретінде қарастырылады.
  • Оқиға серіктестері үшін бұл Оқиғаның жоғары деңгейіне қатысты міндеттеменібұзу ретінде қарастырылады.