API công khai TM

API công khai của Tournament Manager (TM) cho phép các nhà phát triển bên thứ 3 xây dựng các công cụ và tích hợp có thể tương tác với phần mềm Tournament Manager. Một số loại tích hợp (ví dụ: bộ chuyển đổi video hoặc màn hình) được phép, còn một số khác (ví dụ: màn hình hiển thị bộ đếm thời gian trận đấu thay thế) bị cấm. Bài viết này cung cấp tổng quan về TM Public API và liên kết đến thông tin toàn diện hơn.

TM Public API là gì?

• API là một tập hợp các quy tắc và công cụ cho phép các ứng dụng phần mềm khác nhau giao tiếp với nhau. Mục tiêu của TM Public API là cung cấp cơ hội được công nhận chính thức cho các thành viên nâng cao của cộng đồng VEX để phát triển "phần mở rộng" hoặc "phần bổ sung" cho Trình quản lý giải đấu của riêng họ.
• Các ví dụ về tích hợp được khuyến khích/cho phép bao gồm:
  • Tự động ghi lại và/hoặc tải lên các trận đấu thi đấu cá nhân
  • Điều khiển bộ chuyển mạch video để chọn camera liên quan đến trường đang hoạt động
  • Thêm hỗ trợ macropad
  • Điều khiển camera PTZ để hướng đến trường hoạt động
  • Tự động chuyển đổi lựa chọn màn hình hiển thị đối tượng dựa trên các điều kiện khác nhau
  • Tạo nút "bắt đầu trận đấu" lớn một cách hài hước
• TM Public API hiện đang trong giai đoạn đầu và được cung cấp “nguyên trạng” mà không có bất kỳ bảo hành nào. Mặc dù chúng tôi hy vọng có thể duy trì khả năng tương thích trong tương lai, chúng tôi vẫn có quyền sửa đổi hoặc ngừng cung cấp API bất kỳ lúc nào.

Chức năng nào có trong là?

• Lịch thi đấu / kết quả
• Xếp hạng
• Kết quả kỹ năng
• Luồng sự kiện (ví dụ: thời điểm các trận đấu được xếp hàng vào sân, trận đấu bắt đầu, v.v.)
• Các lệnh điều khiển trận đấu cơ bản (ví dụ: bắt đầu/dừng, xếp hàng trận đấu tiếp theo)

Chức năng nào KHÔNG có ở?

• Bất cứ điều gì liên quan đến "viết" hoặc "chỉnh sửa"
• Chỉnh sửa hoặc gửi điểm
• Thông tin thời gian thực trong trận đấu (ví dụ: tỷ số trực tiếp)
• Chỉnh sửa thông tin nhóm
• Sửa đổi cấu hình sự kiện (ví dụ: bộ sân, tạo lịch thi đấu, v.v.)

Tôi là Đối tác sự kiện; làm thế nào để kích hoạt API nếu tôi muốn sử dụng các công cụ của bên thứ ba tại sự kiện của mình?

• Mở Trình quản lý giải đấu và chọn menu Công cụ, sau đó chọn Tùy chọn. Khi cửa sổ Tùy chọn mở ra, hãy chọn danh mục Xuất bản web. Đánh dấu vào ô “Enable Local TM API” và lưu các thay đổi.
• Việc này cần phải được thực hiện mỗi khi có sự kiện mới được tạo.

Tôi là một nhà phát triển; làm thế nào để tôi bắt đầu phát triển với TM API?

• Bạn có thể tìm thấy thêm thông tin trong Hướng dẫn API công khai của Tournament Manager.
• Để bắt đầu, hãy gửi yêu cầu thông tin xác thực API tại liên kết này và cho chúng tôi biết về những gì bạn đang thực hiện. Đừng lo lắng; miễn là đơn đăng ký của bạn nằm trong các hướng dẫn được liệt kê dưới đây thì đơn sẽ được chấp thuận. Điều này sẽ giúp đảm bảo rằng bạn không dồn năng lượng phát triển vào thứ gì đó mà sau này sẽ không được phép!

Quy định & Quy định

• Các ứng dụng của bên thứ ba phải tuân thủ mọi yêu cầu kỹ thuật được liệt kê trong Hướng dẫn API công khai của TM (ví dụ: yêu cầu ký, ID ứng dụng, khóa API, v.v.)
• Phải yêu cầu người dùng "chọn tham gia" thủ công hoặc bật tiện ích bổ sung thủ công thông qua Công cụ > Cài đặt > Xuất bản web > "Bật API TM cục bộ".
• Những điều sau đây về mặt kỹ thuật có thể thực hiện được trong API beta, nhưng bị cấm rõ ràng . Các ứng dụng vi phạm các nguyên tắc này sẽ bị vô hiệu hóa và bị thu hồi thông tin đăng nhập API.
  • Hiển thị bất kỳ loại thời gian trận đấuhoặc sửa đổi bất kỳ thông tin nào liên quan đến thời gian trận đấu, ngoài thông tin có trong Luồng sự kiện của API.
    • Duy trì thời gian chính xác và đồng bộ hóa đúng cách trên mọi thiết bị có thể là một thách thức phức tạp đáng ngạc nhiên liên quan đến nhiều phần của cơ sở dữ liệu mã TM cốt lõi.
    • Không thể dự đoán được những hậu quả không mong muốn nào có thể xảy ra khi cung cấp quyền truy cập vào thông tin này thông qua API công khai và chúng tôi không muốn đặt các EP và nhóm vào tình thế không chắc chắn liệu họ có thể tin tưởng vào thời gian hiển thị trên màn hình của mình hay không.
  • Tạo lại bất kỳ chức năng hiện có nào (ví dụ: tạo “TM Mobile” của riêng bạn)
    • Duy trì trải nghiệm sự kiện cốt lõi nhất quán là nguyên tắc cơ bản của mô hình sự kiện REC Foundation. Các đội phải tin tưởng rằng các công cụ cơ bản được sử dụng tại sự kiện của họ cũng giống như những công cụ được sử dụng ở bất kỳ nơi nào khác và rằng những tình nguyện viên có kinh nghiệm tại một sự kiện có thể chuyển sang sự kiện khác chỉ với đào tạo tối thiểu—cho dù đó là sự kiện giải đấu nhỏ nhất hay Sự kiện đặc trưng lớn nhất!
    • Nếu bạn có ý tưởng cải thiện chức năng hiện có, hãy cho chúng tôi biết trực tiếp! Những thay đổi thực sự mang lại trải nghiệm tốt hơn cho người dùng nên được ghi trực tiếp vào TM và có sẵn cho tất cả các sự kiện.
  • Sửa đổi hoặc tạo lại bất kỳ màn hình hiển thị đối tượng
    • Ngoài các lưu ý về tính nhất quán được đề cập ở trên, nội dung có trong màn hình hiển thị chính thức cho khán giả là kết quả của quá trình thiết kế & thẩm định quan trọng giữa các nhà tài trợ của REC Foundation, các nhóm hỗ trợ tiếp cận và các nhóm quản lý tiếp thị/thương hiệu.
    • Mặc dù việc sửa đổi cách hiển thị có vẻ vô hại trong bối cảnh của một sự kiện đơn lẻ, nhưng chúng thường có thể gây ra những hậu quả không mong muốn ảnh hưởng đến Quỹ REC trên quy mô lớn hơn (ví dụ: thỏa thuận tài trợ hoặc hạn chế sử dụng hình ảnh có bản quyền).
  • Truy cập hoặc sửa đổi bất kỳ thành phần nội bộ nào của Tournament Manager bên ngoài các giao thức API mở chính thức
    • Các sửa đổi của bên thứ ba, khi được tạo ra một cách không chính thức, có thể gây ra nguy cơ làm mất tính toàn vẹn của sự kiện. Các điểm vào API chính thức được tạo ra một cách có chủ đích như một con đường quen thuộc cho các tiện ích mở rộng của bên thứ ba giúp giảm thiểu hoặc loại bỏ rủi ro này.
    • Những sửa đổi bên ngoài các kênh này, ngoài việc vi phạm các nguyên tắc này, còn có thể khiến các EP hoặc nhóm rơi vào tình thế không thể tin tưởng vào phần mềm điều hành sự kiện của họ.
• Lưu ý: Đây cũng là lĩnh vực chưa được chúng tôi khám phá! Chúng tôi có thể có một số ý tưởng về Công cụ TM mà cộng đồng có thể quan tâm, nhưng sự sáng tạo của bạn không bao giờ ngừng vượt quá mong đợi của chúng tôi. Vì vậy, những hướng dẫn này có thể sẽ thay đổi theo thời gian khi chương trình TM Tools mở rộng và chúng ta bắt đầu thấy được những lợi ích từ chương trình này!
• Xin nhắc lại, bất kỳ việc sử dụng phần mềm trái phép hoặc sửa đổi bất hợp pháp (tức là phần mềm vi phạm bất kỳ hướng dẫn nào trong số các hướng dẫn này) trong Sự kiện vòng loại chính thức đều bị nghiêm cấm .
  • Đối với các nhà phát triển, điều này sẽ dẫn đến việc thông tin đăng nhập API của họ bị thu hồi và ứng dụng của họ bị vô hiệu hóa.
  • Đối với sinh viên hoặc các thành viên khác trong nhóm, điều này sẽ được coi là vi phạm Quy tắc ứng xử của Quỹ REC.
  • Đối với Đối tác sự kiện, điều này sẽ được coi là vi phạm Cam kết về sự kiện xuất sắc.