TM 公共 API

• API 是一组允许不同软件应用程序相互通信的规则和工具。 TM 公共 API 的目标是为 VEX 社区的高级成员提供官方认可的机会来开发他们自己的锦标赛管理器“扩展”或“附加组件”。
• 鼓励/允许整合的例子包括：
  • 自动录制和/或上传个人比赛
  • 控制视频切换器选择与活动字段关联的摄像机
  • 添加宏键盘支持
  • 控制 PTZ 摄像机指向活动字段
  • 根据各种情况自动切换观众显示屏选择
  • 制作一个大得可笑的“开始比赛”按钮
• TM Public API 尚处于早期阶段，且“按原样”提供，不提供任何形式的担保。 虽然我们希望将来保持兼容性，但我们保留随时修改或停止 API 的权利。

有那些功能 可用？

• 赛事日程/结果
• 排名
• 技能结果
• 事件流（例如比赛排队进入场地、比赛开始的时刻等）
• 基本比赛控制命令（例如，开始/停止、排队下一场比赛）

哪些功能 不能用 呢？

• 任何与“写作”或“编辑”相关的内容
• 编辑或提交分数
• 比赛期间的实时信息（例如实时比分）
• 编辑团队信息
• 修改事件配置（例如，场地设置、生成比赛日程表等）

我是活动合作伙伴；如果我想在活动中使用第三方工具，如何启用 API？

• 打开锦标赛管理器并选择“工具”菜单，然后选择“选项”。 当“选项”窗口打开时，选择“Web 发布”类别。 选中“启用本地 TM API”复选框并保存更改。
• 每次创建新事件时都需要执行此操作。

我是一名开发人员；如何开始使用 TM API 进行开发？

• 更多信息可以在 锦标赛管理器公共 API 指南中找到。
• 首先，请通过此链接 提交 API 凭证请求 ，并告诉我们您正在进行的工作。 不用担心；只要您的申请符合以下列出的指导方针，它就会被批准。 这将有助于确保您不会把开发精力投入到最终不被允许的事情上！

规则 & 条例

• 第三方应用程序必须遵循 TM 公共 API 指南中列出的所有技术要求（例如，请求签名、App ID、API 密钥等）
• 必须要求用户手动“选择加入”或通过工具 > 设置 > Web 发布 > “启用本地 TM API”手动启用附加组件。
• 从技术角度来看，下列操作在测试版 API 中可能是可行的，但是 明确禁止。 违反这些准则的应用程序将被禁用，并且其 API 凭证也会被撤销。
  • 显示任何类型的 比赛时间，或修改与比赛时间相关的任何内容，而不是 API 的事件流中包含的信息。
    • 保持准确的时间并在所有可能的设备上正确同步它是一项非常复杂的挑战，它与核心 TM 代码库的许多部分交织在一起。
    • 我们无法预测通过面向公众的 API 提供对此的访问权限可能会导致什么意外后果，并且我们不希望让 EP 和团队处于不确定是否可以信任屏幕上显示的时间的境地。
  • 重新创建 任何现有功能（例如，制作自己的“TM Mobile”）
    • 保持一致的核心活动体验是 REC 基金会活动模型的基本原则。 团队应该能够相信，在他们的活动中使用的基本工具与在其他地方使用的相同，并且具有一项活动经验的志愿者经过最少的培训就可以转到另一项活动——无论是最小的联盟活动还是最大的标志性活动！
    • 如果您对如何改进现有功能有任何想法，请直接告诉我们！ 真正提供更好用户体验的更改应该直接写入 TM 并提供给所有事件。
  • 修改或重新创建任何 观众显示
    • 除了上面提到的一致性说明之外，官方观众展示中包含的内容是 REC 基金会赞助商、无障碍团体以及营销/品牌管理团队之间关键设计 & 审查流程的结果。
    • 尽管在单一事件背景下显示修改可能看似无害，但它们往往会产生意想不到的后果，从而在更大范围内影响 REC 基金会（例如，赞助协议或对受版权保护图像的使用限制）。
  • 在官方开放 API 协议之外访问或修改锦标赛管理器 的任何内部组件
    • 当第三方修改非官方创建时，可能会损害事件的完整性。 官方 API 入口点被特意创建为第三方扩展的已知途径，以最大限度地降低或消除这种风险。
    • 除了违反这些准则之外，这些渠道之外的修改还可能使 EP 或团队无法信任运行其活动的软件。
• 注意：这对我们来说也是未知领域！ 我们可能对社区可能感兴趣的 TM 工具有一些想法，但您的创造力永远不会超出我们的预期。 因此，随着 TM Tools 计划的扩展以及我们开始看到其结果，这些指南可能会随着时间的推移而发展！
• 提醒一下，在官方资格赛中使用任何未经授权或非法修改的软件（即违反任何这些准则的软件）都是 禁止的
  • 对于开发人员来说，这将导致他们的 API 凭证被撤销并且他们的应用程序被禁用。
  • 对于学生或其他团队成员来说，这将被视为违反 REC 基金会行为准则。
  • 对于活动合作伙伴来说，这将被视为违反“ 对活动卓越的承诺。