TM สาธารณะ API

API สาธารณะของ Tournament Manager (TM) ช่วยให้นักพัฒนาบุคคลที่สามสามารถสร้างเครื่องมือและการผสานรวมที่ทำงานร่วมกับซอฟต์แวร์ Tournament Manager ได้ อนุญาตให้มีการผสานรวมบางประเภท (เช่น การสลับวิดีโอหรือการแสดงผล) แต่ห้ามมีการผสานรวมบางประเภท (เช่น การแสดงตัวจับเวลาการแข่งขันแบบทางเลือก) บทความนี้ให้ภาพรวมของ TM Public API และลิงก์ไปยังข้อมูลที่ครอบคลุมยิ่งขึ้น

TM Public API คืออะไร?

• API และ เป็นชุดกฎและเครื่องมือที่ช่วยให้แอปพลิเคชันซอฟต์แวร์ต่างๆ สื่อสารกัน เป้าหมายของ TM Public API คือการมอบโอกาสที่ได้รับการยอมรับอย่างเป็นทางการแก่สมาชิกขั้นสูงของชุมชน VEX ในการพัฒนา "ส่วนขยาย" หรือ "ส่วนเสริม" ของ Tournament Manager ของตนเอง
• ตัวอย่างการบูรณาการที่ได้รับการสนับสนุน / อนุญาต ได้แก่:
  • การบันทึกและ/หรืออัปโหลดการแข่งขันแบบรายบุคคลโดยอัตโนมัติ
  • การควบคุมสวิตช์วิดีโอเพื่อเลือกกล้องที่เชื่อมโยงกับฟิลด์ที่ใช้งานอยู่
  • การเพิ่มการรองรับ Macropad
  • การควบคุมกล้อง PTZ ให้ชี้ไปที่พื้นที่ใช้งาน
  • สลับการเลือกหน้าจอแสดงผลของผู้ชมโดยอัตโนมัติตามเงื่อนไขต่างๆ
  • การสร้างปุ่ม “เริ่มแมตช์” ขนาดใหญ่แบบตลกๆ
• TM Public API ยังอยู่ในช่วงเริ่มต้นและให้บริการ "ตามที่เป็น" โดยไม่มีการรับประกันใดๆ ทั้งสิ้น แม้ว่าเราหวังว่าจะรักษาความเข้ากันได้ในอนาคต แต่เราขอสงวนสิทธิ์ในการแก้ไขหรือยกเลิก API ได้ตลอดเวลา

ฟังก์ชัน และ มีให้ใช้อะไรบ้าง?

• ตารางการแข่งขัน / ผลการแข่งขัน
• อันดับ
• ผลลัพธ์ทักษะ
• สตรีมเหตุการณ์ (เช่น ช่วงเวลาที่การแข่งขันเข้าคิวในฟิลด์ การแข่งขันเริ่มต้น ฯลฯ)
• คำสั่งควบคุมการแข่งขันพื้นฐาน (เช่น เริ่ม/หยุด จัดคิวการแข่งขันครั้งต่อไป)

ฟังก์ชัน ไม่มีให้ใช้ ได้อย่างไร?

• อะไรก็ตามที่เกี่ยวข้องกับการ “เขียน” หรือ “แก้ไข”
• การแก้ไขหรือส่งคะแนน
• ข้อมูลแบบเรียลไทม์ระหว่างการแข่งขัน (เช่น คะแนนสด)
• การแก้ไขข้อมูลทีม
• การแก้ไขการกำหนดค่าเหตุการณ์ (เช่น ชุดสนาม การสร้างตารางการแข่งขัน ฯลฯ)

ฉันเป็นพันธมิตรงานอีเว้นท์ ฉันจะเปิดใช้งาน API ได้อย่างไรหากต้องการใช้เครื่องมือของบุคคลที่สามในงานของฉัน?

• เปิด Tournament Manager และเลือกเมนูเครื่องมือ จากนั้นเลือกตัวเลือก เมื่อหน้าต่างตัวเลือกเปิดขึ้น ให้เลือกหมวดหมู่การเผยแพร่ทางเว็บ ทำเครื่องหมายที่ช่องกาเครื่องหมาย “เปิดใช้งาน Local TM API” และบันทึกการเปลี่ยนแปลง
• สิ่งนี้จะต้องดำเนินการทุกครั้งที่มีการสร้างกิจกรรมใหม่

ฉันเป็นนักพัฒนา ฉันจะเริ่มต้นการพัฒนาด้วย TM API ได้อย่างไร?

• สามารถดูข้อมูลเพิ่มเติมได้ใน Tournament Manager Public API Guide
• ในการเริ่มต้น ให้ส่งคำขอข้อมูลรับรอง API ที่ลิงก์นี้ และแจ้งให้เราทราบเกี่ยวกับสิ่งที่คุณกำลังดำเนินการอยู่ ไม่ต้องกังวล ตราบใดที่ใบสมัครที่คุณต้องการเป็นไปตามแนวทางที่ระบุไว้ด้านล่างนี้ ก็ควรจะได้รับการอนุมัติ สิ่งนี้จะช่วยให้แน่ใจว่าคุณไม่ได้ใส่พลังงานในการพัฒนาลงไปในสิ่งที่ไม่ได้รับอนุญาตในภายหลัง!

กฎ & ข้อบังคับ

• แอปพลิเคชันของบริษัทอื่นจะต้องปฏิบัติตามข้อกำหนดทางเทคนิคทั้งหมดที่ระบุไว้ใน TM Public API Guide (เช่น การลงนามคำขอ, ID แอป, คีย์ API เป็นต้น)
• จะต้องกำหนดให้ผู้ใช้ต้อง “เลือกเข้า” หรือเปิดใช้งานส่วนเสริมด้วยตนเองผ่านเครื่องมือ > การตั้งค่า > การเผยแพร่ทางเว็บ > “เปิดใช้งาน Local TM API”
• สิ่งต่อไปนี้อาจเป็นไปได้ในทางเทคนิคใน API เบต้า แต่ห้ามไว้โดยชัดแจ้ง หากพบว่าแอปพลิเคชั่นละเมิดแนวปฏิบัตินี้ แอปพลิเคชั่นดังกล่าวจะถูกปิดการใช้งานและจะถูกเพิกถอนข้อมูลรับรอง API
  • การแสดงเวลาจับคู่ประเภทใดๆหรือการแก้ไขสิ่งใดๆ ที่เกี่ยวข้องกับเวลาจับคู่ นอกเหนือจากข้อมูลที่มีอยู่ใน Event Stream ของ API
    • การรักษาเวลาที่แม่นยำและการซิงโครไนซ์เวลาอย่างถูกต้องในทุกอุปกรณ์ที่เป็นไปได้ถือเป็นความท้าทายที่ซับซ้อนอย่างน่าประหลาดใจซึ่งเชื่อมโยงอยู่ในส่วนต่างๆ มากมายของฐานโค้ดหลักของ TM
    • เป็นไปไม่ได้ที่จะคาดเดาผลลัพธ์ที่ไม่พึงประสงค์ที่อาจเกิดขึ้นจากการให้การเข้าถึงข้อมูลนี้ผ่าน API ที่เผยแพร่สู่สาธารณะ และเราไม่ต้องการทำให้ EP และทีมงานต้องตกอยู่ในสถานการณ์ที่พวกเขาไม่แน่ใจว่าสามารถไว้วางใจเวลาที่แสดงบนหน้าจอได้หรือไม่
  • การสร้างฟังก์ชันที่มีอยู่ใหม่ อย่าง (เช่น การสร้าง “TM Mobile” ของคุณเอง)
    • การรักษาประสบการณ์กิจกรรมหลักที่สอดคล้องกันถือเป็นหลักการพื้นฐานของโมเดลกิจกรรมของ REC Foundation ทีมงานควรสามารถไว้วางใจได้ว่าเครื่องมือพื้นฐานที่ใช้ในงานของตนเป็นชนิดเดียวกันกับที่ใช้ในที่อื่นๆ และอาสาสมัครที่มีประสบการณ์ในงานหนึ่งๆ สามารถข้ามไปงานอื่นได้ด้วยการฝึกอบรมเพียงเล็กน้อย ไม่ว่าจะเป็นงานลีกที่เล็กที่สุดหรืองาน Signature Event ที่ใหญ่ที่สุดก็ตาม
    • หากคุณมีแนวคิดว่าฟังก์ชันที่มีอยู่สามารถปรับปรุงได้อย่างไร โปรดแจ้งให้เราทราบโดยตรง! การเปลี่ยนแปลงที่มอบประสบการณ์ผู้ใช้ที่ดีขึ้นอย่างแท้จริงควรเขียนลงใน TM โดยตรงและพร้อมใช้งานสำหรับทุกกิจกรรม
  • การแก้ไขหรือสร้างใหม่การแสดงผู้ชม คน
    • นอกเหนือจากบันทึกความสอดคล้องที่กล่าวถึงข้างต้นแล้ว เนื้อหาที่รวมอยู่ในรายการแสดงให้ผู้ชมอย่างเป็นทางการยังเป็นผลมาจากกระบวนการตรวจสอบการออกแบบที่ & ระหว่างผู้สนับสนุนมูลนิธิ REC กลุ่มการเข้าถึง และทีมการตลาด/การจัดการแบรนด์
    • แม้ว่าการปรับเปลี่ยนการแสดงอาจดูไม่เป็นอันตรายในบริบทของเหตุการณ์ครั้งเดียว แต่บ่อยครั้งอาจส่งผลกระทบที่ไม่ได้ตั้งใจซึ่งส่งผลกระทบต่อมูลนิธิ REC ในระดับที่ใหญ่กว่า (เช่น ข้อตกลงการสนับสนุนหรือข้อจำกัดในการใช้รูปภาพที่มีลิขสิทธิ์)
  • การเข้าถึงหรือแก้ไขส่วนประกอบภายในใดๆ ของ Tournament Manager นอกโปรโตคอล API เปิดอย่างเป็นทางการ
    • การดัดแปลงของบุคคลที่สาม เมื่อสร้างขึ้นโดยไม่เป็นทางการ อาจมีความเสี่ยงที่จะกระทบต่อความสมบูรณ์ของเหตุการณ์ได้ จุดเข้า API อย่างเป็นทางการได้รับการสร้างขึ้นโดยเจตนาเพื่อให้เป็นช่องทางที่ทราบสำหรับส่วนขยายของบุคคลที่สามซึ่งจะช่วยลดหรือขจัดความเสี่ยงนี้
    • การปรับเปลี่ยนนอกช่องทางเหล่านี้ นอกจากจะถือเป็นการละเมิดแนวปฏิบัติเหล่านี้แล้ว ยังอาจทำให้ EP หรือทีมตกอยู่ในสถานการณ์ที่ไม่สามารถไว้วางใจซอฟต์แวร์ที่รันงานกิจกรรมของตนได้
• หมายเหตุ: นี่เป็นดินแดนที่ยังไม่ได้สำรวจสำหรับเราเช่นกัน! เราอาจมีไอเดียบางอย่างเกี่ยวกับสิ่งที่ชุมชนอาจสนใจเกี่ยวกับ TM Tools แต่ความคิดสร้างสรรค์ของคุณไม่เคยหยุดที่จะเกินความคาดหวังของเรา ดังนั้น แนวทางปฏิบัติดังกล่าวอาจมีการเปลี่ยนแปลงไปตามกาลเวลา โดยที่โปรแกรม TM Tools ขยายตัว และเราจะเริ่มเห็นผลลัพธ์จากโปรแกรมดังกล่าว!
• ขอเตือนให้คุณทราบว่า การใช้ซอฟต์แวร์ที่ไม่ได้รับอนุญาตหรือดัดแปลงโดยผิดกฎหมาย (เช่น ซอฟต์แวร์ที่ละเมิดแนวปฏิบัติใดๆ เหล่านี้) ในงานคัดเลือกอย่างเป็นทางการนั้น ถือ สิ่งต้องห้ามโดยเด็ดขาด
  • สำหรับนักพัฒนา การกระทำดังกล่าวจะส่งผลให้ข้อมูลรับรอง API ของพวกเขาถูกเพิกถอน และแอปพลิเคชันของพวกเขาจะถูกปิดการใช้งาน
  • สำหรับนักเรียนหรือสมาชิกทีมอื่นๆ จะถือเป็นการละเมิดจรรยาบรรณของมูลนิธิ REC
  • สำหรับพันธมิตรงานกิจกรรม จะถือเป็นการละเมิด ความมุ่งมั่นเพื่อความเป็นเลิศของงานกิจกรรม