API pública TM

A API pública do Tournament Manager (TM) permite que desenvolvedores terceirizados criem ferramentas e integrações que interoperem com o software Tournament Manager. Alguns tipos de integrações (por exemplo, alternadores de vídeo ou exibição) são permitidos, e outros (por exemplo, exibições alternativas de cronômetro de partida) são proibidos. Este artigo fornece uma visão geral da API pública do TM e um link para informações mais abrangentes.

O que é a API pública do TM?

• Uma API é um conjunto de regras e ferramentas que permitem que diferentes aplicativos de software se comuniquem entre si. O objetivo da TM Public API é fornecer uma oportunidade oficialmente reconhecida para membros avançados da comunidade VEX desenvolverem suas próprias “extensões” ou “add-ons” do Tournament Manager.
• Exemplos de integrações incentivadas/permitidas incluem:
  • Gravação e/ou upload automático de partidas individuais de competição
  • Controlando um comutador de vídeo para selecionar uma câmera associada ao campo ativo
  • Adicionando suporte a macropad
  • Controlando uma câmera PTZ para apontar para o campo ativo
  • Troca automática da tela de exibição do público com base em várias condições
  • Criando um botão “iniciar partida” comicamente grande
• A API pública do TM está em seus estágios iniciais e é fornecida “no estado em que se encontra”, sem garantia de qualquer tipo. Embora esperemos manter a compatibilidade no futuro, reservamo-nos o direito de modificar ou descontinuar a API a qualquer momento.

Qual funcionalidade está disponível?

• Calendário de jogos / resultados
• Classificações
• Resultados de habilidades
• Fluxo de eventos (por exemplo, o momento em que as partidas são enfileiradas nos campos, a partida começa, etc.)
• Comandos básicos de controle de partida (por exemplo, iniciar/parar, enfileirar a próxima partida)

Qual funcionalidade está disponível?

• Qualquer coisa relacionada a “escrever” ou “editar”
• Edição ou envio de partituras
• Informações em tempo real durante uma partida (por exemplo, pontuação ao vivo)
• Editando informações da equipe
• Modificando a configuração do evento (por exemplo, conjuntos de campos, geração de cronogramas de correspondências, etc.)

Sou um parceiro de evento; como habilito a API se quiser usar ferramentas de terceiros no meu evento?

• Abra o Gerenciador de Torneios e selecione o menu Ferramentas e depois Opções. Quando a janela Opções abrir, selecione a categoria Publicação na Web. Marque a caixa de seleção “Habilitar API TM local” e salve as alterações.
• Isso precisará ser feito sempre que um novo evento for criado.

Sou um desenvolvedor; como começo a desenvolver com a API do TM?

• Mais informações podem ser encontradas no Guia da API Pública do Tournament Manager .
• Para começar, envie uma solicitação de credenciais de API neste link e conte-nos no que você está trabalhando. Não se preocupe; desde que sua inscrição pretendida esteja dentro das diretrizes listadas abaixo, ela deverá ser aprovada. Isso ajudará a garantir que você não esteja investindo energia de desenvolvimento em algo que acabará não sendo permitido mais tarde!

Regras & Regulamentos

• Os aplicativos de terceiros devem seguir todos os requisitos técnicos listados no Guia da API Pública da TM (por exemplo, assinatura de solicitação, ID do aplicativo, chaves de API, etc.)
• Deve exigir que o usuário faça a “opção de inclusão” manualmente ou habilite o complemento manualmente por meio de Ferramentas > Configurações > Publicação na Web > “Habilitar API de TM local”.
• As seguintes coisas podem ser tecnicamente possíveis na API beta, mas são explicitamente proibidas. Os aplicativos que violarem essas diretrizes serão desabilitados e terão suas credenciais de API revogadas.
  • Exibir qualquer tipo de tempo de partidaou modificar qualquer coisa relacionada ao tempo de partida, além das informações contidas no Fluxo de Eventos da API.
    • Manter a hora exata e sincronizá-la corretamente em todos os dispositivos possíveis é um desafio surpreendentemente complexo que está interligado a muitas partes da base de código principal do TM.
    • É impossível prever quais consequências não intencionais podem resultar do fornecimento de acesso a isso por meio de uma API pública, e não queremos colocar os EPs e as equipes em uma posição em que não tenham certeza se podem confiar no tempo exibido em suas telas.
  • Recriar qualquer funcionalidade existente (por exemplo, criar seu próprio “TM Mobile”)
    • Manter uma experiência consistente no evento principal é um princípio fundamental do modelo de evento da REC Foundation. As equipes devem poder confiar que as ferramentas fundamentais usadas em seus eventos são as mesmas usadas em qualquer outro lugar, e que os voluntários com experiência em um evento podem passar para outro evento com treinamento mínimo, seja o menor evento da liga ou o maior evento exclusivo!
    • Se você tiver ideias sobre como uma função existente pode ser melhorada, informe-nos diretamente! As alterações que realmente proporcionam uma melhor experiência ao usuário devem ser gravadas diretamente no TM e disponibilizadas para todos os eventos.
  • Modificando ou recriando quaisquer exibições de público
    • Além das notas de consistência mencionadas acima, o conteúdo incluído nas exibições oficiais do público é o resultado de processos & de verificação de design entre patrocinadores da REC Foundation, grupos de acessibilidade e equipes de marketing/gerenciamento de marca.
    • Embora as modificações na exibição possam parecer inocentes no contexto de um único evento, elas podem frequentemente ter consequências não intencionais que impactam a Fundação REC em uma escala maior (por exemplo, acordos de patrocínio ou limitações no uso de uma imagem protegida por direitos autorais).
  • Acessar ou modificar quaisquer componentes internos do Tournament Manager fora dos protocolos oficiais de API aberta
    • Modificações de terceiros, quando criadas não oficialmente, representam um risco potencial de comprometer a integridade do evento. Os pontos de entrada oficiais da API foram criados intencionalmente como um meio conhecido para extensões de terceiros que minimizam ou eliminam esse risco.
    • Modificações fora desses canais, além de serem uma violação dessas diretrizes, podem colocar os EPs ou equipes em uma posição em que não podem confiar no software que executa o evento.
• Observação: esse também é um território inexplorado para nós! Podemos ter algumas ideias sobre quais Ferramentas de TM podem interessar à comunidade, mas sua criatividade nunca deixa de superar nossas expectativas. Portanto, essas diretrizes provavelmente evoluirão com o tempo, à medida que o programa TM Tools se expandir e começarmos a ver o que resultará dele!
• Como lembrete, qualquer uso de software não autorizado ou modificado ilegalmente (ou seja, software que viole qualquer uma dessas diretrizes) em um Evento Qualificatório oficial é estritamente proibido.
  • Para os desenvolvedores, isso resultará na revogação de suas credenciais de API e na desativação de seus aplicativos.
  • Para alunos ou outros membros da equipe, isso será tratado como uma violação do Código de Conduta da Fundação REC.
  • Para Parceiros de Eventos, isso será tratado como uma violação do com a Excelência do Evento.