TM API pública

La API pública de Tournament Manager (TM) permite a los desarrolladores de terceros crear herramientas e integraciones que interoperan con el software de Tournament Manager. Se permiten algunos tipos de integraciones (por ejemplo, conmutadores de video o pantalla) y se prohíben otros (por ejemplo, pantallas de temporizador de coincidencia alternativas). Este artículo proporciona una descripción general de la API pública de MT y un enlace a información más completa.

¿Qué es la API pública de MT?

• Una API es un conjunto de reglas y herramientas que permiten que diferentes aplicaciones de software se comuniquen entre sí. El objetivo de la API pública de TM es proporcionar una oportunidad oficialmente reconocida para que los miembros avanzados de la comunidad VEX desarrollen sus propias "extensiones" o "complementos" de Tournament Manager.
• Los ejemplos de integraciones alentadas / permitidas incluyen:
  • Grabar y/o cargar automáticamente partidos de competición individuales
  • Control de un conmutador de video para seleccionar una cámara asociada con el campo activo
  • Agregar soporte para macropad
  • Control de una cámara PTZ para apuntar al campo activo
  • Cambiar automáticamente la selección de la pantalla de visualización de la audiencia en función de varias condiciones
  • Hacer un botón de "inicio de partido" cómicamente grande
• La API pública de TM se encuentra en sus primeras etapas y se proporciona "tal cual" sin garantía de ningún tipo. Si bien esperamos mantener la compatibilidad en el futuro, nos reservamos el derecho de modificar o descontinuar la API en cualquier momento.

¿Qué funcionalidad está disponible?

• Cronograma / resultados del partido
• Clasificaciones
• Resultados de habilidades
• Transmisión de eventos (por ejemplo, el momento en que las coincidencias se ponen en cola en los campos, se inician las coincidencias, etc.)
• Comandos básicos de control de coincidencias (por ejemplo, iniciar/detener, poner en cola la siguiente coincidencia)

¿Qué funcionalidad NO está disponible?

• Cualquier cosa relacionada con "escribir" o "editar"
• Editar o enviar puntuaciones
• Información en tiempo real durante un partido (por ejemplo, puntuación en vivo)
• Editar la información del equipo
• Modificación de la configuración de eventos (por ejemplo, conjuntos de campos, generación de horarios de partidos, etc.)

Soy un socio de eventos; ¿cómo habilito la API si quiero utilizar herramientas de terceros en mi evento?

• Abra el Administrador de torneos y seleccione el menú Herramientas, luego Opciones. Cuando se abra la ventana Opciones, seleccione la categoría Publicación web. Marque la casilla de verificación "Habilitar API de TM local" y guarde los cambios.
• Esto deberá hacerse cada vez que se cree un nuevo evento.

Soy desarrollador; ¿cómo empiezo a desarrollar con la API de MT?

• Puedes encontrar más información en la Guía de la API pública de Tournament Manager.
• Para empezar, envía una solicitud de credenciales de API a través de este enlace y cuéntanos en qué estás trabajando. No se preocupe; siempre que su solicitud prevista se ajuste a las pautas que se enumeran a continuación, debe ser aprobada. ¡Esto ayudará a asegurarse de que no está poniendo energía de desarrollo en algo que terminará no permitiéndose más adelante!

Reglas & Regulaciones

• Las aplicaciones de terceros deben seguir todos los requisitos técnicos enumerados en la Guía de API pública de TM (por ejemplo, firma de solicitudes, ID de aplicación, claves de API, etc.)
• Debe requerir que el usuario "opte por participar" manualmente o habilite el complemento manualmente a través de Tools > Settings > Web Publishing > "Enable Local TM API".
• Las siguientes cosas pueden ser técnicamente posibles en la API beta, pero están explícitamente prohibidas. Las aplicaciones que infrinjan estas directrices se desactivarán y se revocarán sus credenciales de API.
  • Mostrar cualquier tipo de tiempo de partido, o modificar cualquier cosa relacionada con el tiempo de partido, que no sea la información contenida en la secuencia de eventos de la API.
    • Mantener el tiempo preciso y sincronizarlo correctamente en todos los dispositivos posibles es un desafío sorprendentemente complejo que se entrelaza en muchas partes de la base de código central de TM.
    • Es imposible predecir qué consecuencias no deseadas pueden resultar de proporcionar acceso a esto a través de una API pública, y no queremos colocar a los EP y equipos en una posición en la que no estén seguros de si pueden confiar en el tiempo que se muestra en sus pantallas.
  • Recrear cualquier funcionalidad existente (por ejemplo, crear su propio "TM Mobile")
    • Mantener una experiencia de evento central consistente es un principio fundamental del modelo de eventos de Rec Foundation. Los equipos deben poder confiar en que las herramientas fundamentales que se utilizan en su evento son las mismas que se utilizan en cualquier otro lugar, y que los voluntarios con experiencia en un evento pueden saltar a otro evento con una capacitación mínima, ¡ya sea el evento de liga más pequeño o el evento de firma más grande!
    • Si tiene ideas sobre cómo se podría mejorar una función existente, ¡háganoslo saber directamente! Los cambios que realmente proporcionan una mejor experiencia de usuario deben escribirse en TM directamente y estar disponibles para todos los eventos.
  • Modificar o recrear cualquier visualización de audiencia
    • Además de las notas de coherencia mencionadas anteriormente, el contenido incluido en las pantallas oficiales de la audiencia es el resultado de procesos críticos de & investigación de diseño entre los patrocinadores de la Fundación Rec, los grupos de accesibilidad y los equipos de marketing /gestión de marca.
    • Aunque las modificaciones de la pantalla pueden parecer inocentes en el contexto de un solo evento, a menudo pueden tener consecuencias no deseadas que afectan a la Fundación Rec a mayor escala (por ejemplo, acuerdos de patrocinio o limitaciones en el uso de una imagen con derechos de autor).
  • Acceder o modificar cualquier componente interno de Tournament Manager fuera de los protocolos oficiales de la API abierta
    • Las modificaciones de terceros, cuando se crean de manera no oficial, representan un riesgo potencial de comprometer la integridad del evento. Los puntos de entrada oficiales de la API se han creado intencionalmente como una vía conocida para extensiones de terceros que minimiza o elimina este riesgo.
    • Las modificaciones fuera de estos canales, además de ser una violación de estas pautas, pueden poner a los EP o equipos en una posición en la que no puedan confiar en el software que ejecuta su evento.
• Nota: ¡Este es un territorio inexplorado para nosotros también! Es posible que tengamos algunas ideas sobre en qué herramientas de MT puede estar interesada la comunidad, pero su creatividad nunca deja de superar nuestras expectativas. Entonces, ¡estas pautas probablemente evolucionarán con el tiempo a medida que el programa TM Tools se expanda y comencemos a ver qué sale de él!
• Como recordatorio, cualquier uso de software no autorizado o modificado ilegalmente (es decir, software que viole cualquiera de estas pautas) en un Evento clasificatorio oficial está estrictamente prohibido.
  • Para los desarrolladores, esto dará como resultado la revocación de sus credenciales de API y la desactivación de sus aplicaciones.
  • Para los estudiantes u otros miembros del equipo, esto se tratará como una violación del Código de Conducta de la Fundación Rec.
  • Para los Socios del Evento, esto se tratará como una violación del Compromiso con la Excelencia del Evento.