TM Publiczne API

• API to zbiór reguł i narzędzi umożliwiających różnym aplikacjom oprogramowania wzajemną komunikację. Celem publicznego interfejsu API TM jest zapewnienie oficjalnie uznanej możliwości zaawansowanym członkom społeczności VEX opracowywania własnych rozszerzeń lub dodatków do Tournament Manager.
• Przykłady integracji zalecanych/dozwolonych obejmują:
  • Automatyczne rejestrowanie i/lub przesyłanie poszczególnych meczów rozgrywek
  • Sterowanie przełącznikiem wideo w celu wybrania kamery powiązanej z aktywnym polem
  • Dodanie obsługi makr
  • Sterowanie kamerą PTZ w celu skierowania jej na pole aktywne
  • Automatyczne przełączanie wyboru ekranu wyświetlania dla odbiorców w oparciu o różne warunki
  • Tworzenie komicznie dużego przycisku „Rozpocznij mecz”
• Publiczny interfejs API TM jest na wczesnym etapie rozwoju i jest udostępniany „tak jak jest”, bez jakiejkolwiek gwarancji. Mamy nadzieję, że w przyszłości uda nam się zachować kompatybilność, jednak zastrzegamy sobie prawo do modyfikacji lub zaprzestania udostępniania interfejsu API w dowolnym momencie.

Jaka funkcjonalność jest dostępna?

• Harmonogram meczów / wyniki
• Rankingi
• Wyniki umiejętności
• Strumień zdarzeń (np. moment, w którym dopasowania są umieszczane w kolejce do pól, rozpoczęcie dopasowania itp.)
• Podstawowe polecenia sterujące meczem (np. start/stop, kolejka następnego meczu)

Jaka funkcjonalność NIE jest dostępna?

• Wszystko co jest związane z „pisaniem” lub „edycją”
• Edytowanie lub przesyłanie wyników
• Informacje w czasie rzeczywistym podczas meczu (np. wyniki na żywo)
• Edytowanie informacji o zespole
• Modyfikowanie konfiguracji zdarzeń (np. zestawów pól, generowanie harmonogramów dopasowań itp.)

Jestem partnerem wydarzenia. Jak mogę włączyć API, jeśli chcę korzystać z narzędzi innych firm podczas swojego wydarzenia?

• Otwórz Tournament Managera i wybierz menu Narzędzia, a następnie Opcje. Po otwarciu okna Opcje wybierz kategorię Publikowanie w Internecie. Zaznacz pole wyboru „Włącz lokalne API TM” i zapisz zmiany.
• Tę czynność należy wykonać za każdym razem, gdy tworzone jest nowe zdarzenie.

Jestem programistą. Jak mogę zacząć programować z wykorzystaniem TM API?

• Więcej informacji można znaleźć w Przewodniku po publicznym interfejsie API Tournament Manager.
• Aby rozpocząć, wyślij prośbę o dane uwierzytelniające API pod tym linkiem i opisz, nad czym pracujesz. Nie martw się. Jeżeli Twój wniosek mieści się w wytycznych wymienionych poniżej, powinien zostać zatwierdzony. Dzięki temu będziesz mieć pewność, że nie wkładasz energii w coś, co później nie będzie dozwolone!

Zasady & Regulaminy

• Aplikacje innych firm muszą spełniać wszystkie wymagania techniczne wymienione w TM Public API Guide (np. podpisywanie żądań, identyfikator aplikacji, klucze API itp.)
• Należy wymagać od użytkownika ręcznego „zaakceptowania” lub ręcznego włączenia dodatku za pomocą opcji Narzędzia > Ustawienia > Publikowanie w sieci > „Włącz lokalny interfejs API TM”.
• Następujące rzeczy mogą być technicznie możliwe w wersji beta API, ale są wyraźnie zabronione. Aplikacje naruszające te wytyczne zostaną wyłączone, a ich dane uwierzytelniające API zostaną cofnięte.
  • Wyświetlanie dowolnego typu czasu dopasowanialub modyfikowanie czegokolwiek związanego z czasem dopasowania, poza informacjami zawartymi w strumieniu zdarzeń API.
    • Utrzymanie dokładnego czasu i jego prawidłowa synchronizacja na wszystkich możliwych urządzeniach to zaskakująco złożone wyzwanie, powiązane z wieloma częściami głównej bazy kodu TM.
    • Nie sposób przewidzieć, jakie niezamierzone konsekwencje może przynieść udostępnienie dostępu do tych danych za pośrednictwem publicznego interfejsu API. Nie chcemy stawiać dyrektorów wykonawczych i zespołów w sytuacji, w której nie będą pewni, czy mogą ufać czasowi wyświetlanemu na ich ekranach.
  • Odtworzenie dowolnej istniejącej funkcjonalności (np. stworzenie własnego „TM Mobile”)
    • Utrzymanie spójnego, spójnego i spójnego charakteru wydarzenia jest fundamentalną zasadą modelu wydarzeń Fundacji REC. Zespoły powinny mieć pewność, że podstawowe narzędzia wykorzystywane podczas ich wydarzenia są takie same, jak te używane gdzie indziej, a wolontariusze mający doświadczenie w pracy na jednym wydarzeniu będą w stanie przeskoczyć do innego po minimalnym przeszkoleniu — bez względu na to, czy jest to najmniejsze wydarzenie ligowe, czy największe wydarzenie firmowe!
    • Jeśli masz pomysły, w jaki sposób można udoskonalić istniejącą funkcję, daj nam znać bezpośrednio! Zmiany, które rzeczywiście zapewnią lepsze wrażenia użytkownika, powinny zostać zapisane bezpośrednio w TM i udostępnione wszystkim użytkownikom.
  • Modyfikowanie lub ponowne tworzenie dowolnych wyświetlaczy odbiorców
    • Oprócz uwag dotyczących spójności, o których mowa powyżej, treści zawarte na oficjalnych wyświetlaczach dla publiczności są wynikiem krytycznych procesów & projektu pomiędzy sponsorami Fundacji REC, grupami ds. dostępności oraz zespołami ds. marketingu/zarządzania marką.
    • Nawet jeśli modyfikacje sposobu wyświetlania mogą wydawać się niewinne w kontekście pojedynczego zdarzenia, często mogą mieć niezamierzone konsekwencje, które wpływają na Fundację REC na większą skalę (np. umowy sponsorskie lub ograniczenia w zakresie korzystania z chronionego prawem autorskim obrazu).
  • Uzyskiwanie dostępu do wewnętrznych komponentów Tournament Manager lub ich modyfikowanie poza oficjalnymi otwartymi protokołami API
    • Modyfikacje wprowadzane przez osoby trzecie, gdy są tworzone nieoficjalnie, niosą ze sobą potencjalne ryzyko naruszenia integralności wydarzenia. Oficjalne punkty wejścia API zostały celowo utworzone jako znana droga dla rozszerzeń innych firm, która minimalizuje lub eliminuje to ryzyko.
    • Modyfikacje dokonywane poza tymi kanałami, oprócz tego, że stanowią naruszenie niniejszych wytycznych, mogą również narazić organizatorów wydarzeń lub zespoły na ryzyko utraty zaufania do oprogramowania obsługującego ich wydarzenie.
• Uwaga: To jest dla nas również niezbadany teren! Mamy pewne pomysły na to, czym TM Tools może zainteresować społeczność, ale Wasza kreatywność nigdy nie przestaje przekraczać naszych oczekiwań. Zatem wytyczne te najprawdopodobniej będą się zmieniać w miarę rozwoju programu TM Tools i gdy zaczniemy dostrzegać, co z tego wyniknie!
• Przypominamy, że jakiekolwiek użycie nieautoryzowanego lub nielegalnie zmodyfikowanego oprogramowania (tj. oprogramowania, które narusza którekolwiek z niniejszych wytycznych) podczas oficjalnego Wydarzenia Kwalifikacyjnego jest zabronione
  • W przypadku programistów będzie to skutkowało unieważnieniem ich danych uwierzytelniających API i wyłączeniem ich aplikacji.
  • W przypadku studentów i innych członków zespołu będzie to traktowane jako naruszenie Kodeksu postępowania Fundacji .
  • W przypadku Partnerów wydarzeń będzie to traktowane jako naruszenie do doskonałości w organizacji wydarzeń.