Tournament Manager (TM) パブリック API を使用すると、サードパーティの開発者は Tournament Manager ソフトウェアと相互運用するツールや統合を構築できます。 一部のタイプの統合 (例: ビデオまたはディスプレイ スイッチャー) は許可されますが、その他の統合 (例: 代替マッチ タイマー ディスプレイ) は禁止されています。 この記事では、TM パブリック API の概要と、より包括的な情報へのリンクを示します。
TM パブリック API とは何ですか?
- API は、さまざまなソフトウェア アプリケーションが相互に通信できるようにする一連のルールとツールです。 TM パブリック API の目標は、VEX コミュニティの上級メンバーが独自のトーナメント マネージャーの「拡張機能」または「アドオン」を開発するための公式に認められた機会を提供することです。
- 推奨/許可される統合の例は次のとおりです。
- 個々の競技試合を自動的に記録および/またはアップロードする
- ビデオスイッチャーを制御して、アクティブフィールドに関連付けられたカメラを選択する
- マクロパッドのサポートを追加
- PTZカメラを制御してアクティブなフィールドを向ける
- さまざまな条件に基づいて視聴者表示画面の選択を自動切り替え
- コミカルな大きさの「試合開始」ボタンを作る
- TM パブリック API はまだ初期段階であり、いかなる保証もなく「現状のまま」提供されます。 将来的に互換性を維持したいと考えていますが、API をいつでも変更または中止する権利を留保します。
で利用できる機能は何ですか?
- 試合日程・結果
- ランキング
- スキル結果
- イベント ストリーム (例: 試合がフィールドにキューに入れられた瞬間、試合が開始する瞬間など)
- 基本的な試合制御コマンド(開始/停止、次の試合のキューなど)
では利用でき 機能は何ですか?
- 「書く」または「編集する」ことに関するもの
- スコアの編集または提出
- 試合中のリアルタイム情報(例:ライブスコア)
- チーム情報の編集
- イベント構成の変更 (例: フィールド セット、試合スケジュールの生成など)
私はイベント パートナーです。イベントでサードパーティ ツールを使用する場合、API を有効にするにはどうすればよいでしょうか?
- トーナメント マネージャーを開き、[ツール] メニュー、[オプション] の順に選択します。 オプション ウィンドウが開いたら、Web 公開カテゴリを選択します。 「ローカル TM API を有効にする」チェックボックスをオンにして、変更を保存します。
- これは、新しいイベントが作成されるたびに実行する必要があります。
私は開発者です。TM API を使用して開発を始めるにはどうすればよいですか?
- 詳細については、 トーナメント マネージャー パブリック API ガイドを参照してください。
- 開始するには、このリンク で API 認証情報リクエスト 送信し、作業内容についてお知らせください。 心配しないでください。申請内容が下記のガイドラインに該当する限り、承認されるはずです。 これにより、後で許可されなくなるようなものに開発エネルギーを費やさないようにすることができます。
ルール & 規制
- サードパーティ アプリケーションは、TM パブリック API ガイドに記載されているすべての技術要件 (リクエストの署名、アプリ ID、API キーなど) に従う必要があります。
- ユーザーが手動で「オプトイン」するか、ツール > 設定 > Web 公開 > 「ローカル TM API を有効にする」から手動でアドオンを有効にすることを要求する必要があります。
- 以下のことはベータ API では技術的には可能かもしれませんが 明示的に禁止されています。 これらのガイドラインに違反していることが判明したアプリケーションは無効化され、API 認証情報が取り消されます。
- API のイベント ストリームに含まれる情報以外の、あらゆる種類の 試合時間を表示したり、試合時間に関連する情報を変更したりします。
- 正確な時間を維持し、すべてのデバイス間で正しく同期することは、コア TM コードベースの多くの部分に絡み合っている、驚くほど複雑な課題です。
- 公開 API を通じてこれへのアクセスを提供することで、どのような予期しない結果が生じるかを予測することは不可能であり、EP やチームが画面に表示される時間を信頼できるかどうか確信が持てない状況に陥ることは望んでいません。
-
既存の機能の再現 (例: 独自の「TM Mobile」の作成)
- 一貫したコアイベント体験を維持することは、REC Foundation イベント モデルの基本理念です。 チームは、自分たちのイベントで使用されている基本的なツールが他の場所で使用されているものと同じであり、あるイベントで経験を積んだボランティアが最小限のトレーニングで別のイベントに移行できることを信頼できる必要があります。それが最小のリーグ イベントであっても、最大のシグネチャー イベントであっても同じです。
- 既存の機能を改善するアイデアがあれば、直接お知らせください。 本当に優れたユーザー エクスペリエンスを提供する変更は、TM に直接書き込まれ、すべてのイベントで利用できる必要があります。
-
オーディエンスディスプレイ変更または再作成
- 上記の一貫性に関する注意事項に加えて、公式の視聴者向けディスプレイに含まれるコンテンツは、REC Foundation スポンサー、アクセシビリティ グループ、マーケティング/ブランド管理チーム間の厳密な & 審査プロセスの結果です。
- 表示の変更は単一のイベントの文脈では無害に思えるかもしれませんが、多くの場合、意図しない結果をもたらし、REC Foundation に大規模な影響を与える可能性があります (例: スポンサー契約や著作権で保護された画像の使用制限)。
- 公式オープンAPIプロトコルの外でトーナメントマネージャー の内部コンポーネントにアクセスしたり変更したりすること
- サードパーティによる変更が非公式に作成された場合、イベントの整合性が損なわれる潜在的なリスクが生じます。 公式 API エントリ ポイントは、このリスクを最小限に抑える、または排除するサードパーティ拡張機能の既知の手段として意図的に作成されています。
- これらのチャネル以外での変更は、ガイドライン違反となるだけでなく、EP またはチームがイベントを実行するソフトウェアを信頼できなくなるリスクが生じる可能性があります。
- API のイベント ストリームに含まれる情報以外の、あらゆる種類の 試合時間を表示したり、試合時間に関連する情報を変更したりします。
- 注: これは私たちにとっても未踏の領域です。 コミュニティが興味を持つ可能性のある TM ツールについて、私たちにはいくつかのアイデアがあるかもしれませんが、皆さんの創造性は私たちの期待を常に超えています。 したがって、TM ツール プログラムが拡大し、そこから何が生まれるかが見えてくるにつれて、これらのガイドラインは時間とともに進化していく可能性があります。
- ご注意ください。公式予選イベントで許可されていないソフトウェアや違法に改造されたソフトウェア (つまり、これらのガイドラインに違反するソフトウェア) を使用することは 固く禁止されています。
- 開発者の場合、これにより API 認証情報が取り消され、アプリケーションが無効になります。
- 学生や他のチームメンバーの場合、これは REC Foundation 行動規範の違反として扱われます。
- イベント パートナーの場合、これは イベントの卓越性へのコミットメントの違反として扱われます。