1. RECF 圖書館
  2. 活動夥伴
  3. 跑步活動
  4. 使用錦標賽管理軟體

TM公共API

Tournament Manager (TM) 公共 API 允許第 3 方開發人員建構與 Tournament Manager 軟體互通的工具和整合。 允許某些類型的整合（例如視訊或顯示切換器），而禁止其他類型的整合（例如替代比賽計時器顯示）。 本文提供了 TM Public API 的概述以及更全面資訊的連結。

什麼是 TM 公共 API？

  • API 是一組允許不同軟體應用程式相互溝通的規則和工具。 TM 公共 API 的目標是為 VEX 社群的高級成員提供官方認可的機會來開發自己的錦標賽管理器「擴展」或「附加元件」。
  • 鼓勵/允許的整合範例包括：
    • 自動記錄和/或上傳個人比賽
    • 控制視訊切換器選擇與活動欄位關聯的攝影機
    • 添加巨集鍵盤支持
    • 控制 PTZ 攝影機指向活動區域
    • 根據各種情況自動切換觀眾顯示屏選擇
    • 製作一個大得可笑的「開始比賽」按鈕
  • TM Public API 處於早期階段，「按原樣」提供，不提供任何形式的保證。 雖然我們希望將來保持相容性，但我們保留隨時修改或終止 API 的權利。

可以使用什麼功能 ？

  • 比賽日程/結果
  • 排行榜
  • 技能成果
  • 事件流（例如，比賽排隊到字段的時刻、比賽開始等）
  • 基本比賽控制指令（例如，開始/停止、排隊下一場比賽）

哪些功能 用？

  • 任何與「編寫」或「編輯」相關的內容
  • 編輯或提交分數
  • 比賽期間的即時資訊（例如即時得分）
  • 編輯團隊訊息
  • 修改賽事配置（例如，場地設定、產生比賽行程等）

我是活動夥伴；如果我想在活動中使用第三方工具，如何啟用 API？

  • 開啟錦標賽管理器並選擇“工具”選單，然後選擇“選項”。 當「選項」視窗開啟時，選擇「網路發布」類別。 選取“啟用本機 TM API”複選框並儲存變更。
  • 每次建立新事件時都需要執行此操作。

我是一名開發人員；如何開始使用 TM API 進行開發？

規則 & 規則

  • 第三方應用程式必須遵循TM公共API指南中列出的所有技術要求（例如請求簽名、應用程式ID、API金鑰等）
  • 必須要求使用者手動「選擇加入」或透過工具 > 設定 > 網路發布 > 「啟用本地 TM API」手動啟用附加元件。
  • 以下內容在 Beta API 中技術上可能是可行的，但 明確禁止。 發現違反這些準則的應用程式將被停用，並撤銷其 API 憑證。
    • 顯示任何類型的 比賽時間，或修改與比賽時間相關的任何內容（API 事件流中包含的資訊除外）。
      • 保持準確的時間並在所有可能的設備上正確同步時間是一項極其複雜的挑戰，它貫穿核心 TM 程式碼庫的許多部分。
      • 無法預測透過面向公眾的 API 提供對此的訪問可能會導致什麼意外後果，並且我們不希望 EP 和團隊處於不確定是否可以信任顯示的時間的境地。
    • 重新建立 任何現有功能（例如，製作您自己的“TM Mobile”）
      • 保持一致的核心活動體驗是 REC 基金會活動模式的基本原則。 團隊應該能夠相信，在他們的活動中使用的基本工具與在其他地方使用的基本工具是相同的，並且在一項活動中有經驗的志願者可以通過最少的培訓跳到另一項活動- 無論是最小的聯賽活動還是最大的簽名活動！
      • 如果您對如何改進現有功能有任何想法，請直接告訴我們！ 真正提供更好使用者體驗的變更應直接寫入 TM 並可供所有事件使用。
    • 修改或重新建立任何 觀眾顯示
      • 除了上述一致性說明之外，官方觀眾展示中包含的內容是 REC 基金會贊助商、無障礙團體和行銷/品牌管理團隊之間關鍵設計 & 審查流程的結果。
      • 儘管在單一事件中顯示修改可能看起來是無辜的，但它們通常會產生意想不到的後果，從而在更大範圍內影響REC 基金會（例如，贊助協議或對受版權保護圖像的使用的限制） 。
    • 在官方開放 API 協定之外存取或修改 Tournament Manager 的任何內部元件
      • 第三方修改如果非官方創建，可能會帶來損害事件完整性的潛在風險。 官方 API 入口點是有意創建的，作為第三方擴展的已知途徑，可以最大限度地減少或消除這種風險。
      • 這些管道之外的修改除了違反這些準則之外，還可能導致 EP 或團隊無法信任運行其活動的軟體。
  • 注意：這對我們來說也是一個未被探索的領域！ 對於社區可能感興趣的 TM Tools，我們可能有一些想法，但您的創造力永遠不會超越我們的期望。 因此，隨著 TM Tools 計劃的擴展，這些指南可能會隨著時間的推移而演變，我們開始看看它會帶來什麼！
  • 謹此提醒，嚴禁在官方資格賽中使用任何未經授權或非法修改的軟體（即違反任何這些準則的軟體） 。
    • 對於開發人員來說，這將導致他們的 API 憑證被撤銷並停用他們的應用程式。
    • 對於學生或其他團隊成員，這將被視為違反 REC 基金會行為準則。
    • 對於活動合作夥伴，這將被視為違反 卓越活動承諾。