เอกสาร

เรียนรู้ TicketsX ได้เร็วขึ้น

คู่มือการตั้งค่า รายการคำสั่งทั้งหมด ฟีเจอร์ Premium และ REST API รวมอยู่ที่เดียว

13.24

ขีดจำกัดและความปลอดภัย

API ถูกสร้างมาให้โทเค็นไม่มีทางถูกใช้ทำร้ายเซิร์ฟเวอร์ได้ ต่อให้โทเค็นหลุดออกไปก็ตาม การป้องกันต่อไปนี้มีผลกับทุกคำขอ

ทุกปลายทางจะตรวจ Premium ก่อนสิ่งอื่นใด ก่อนจะไปค้นหาโทเค็นและก่อนจะนับขีดจำกัดใดๆ เซิร์ฟเวอร์ที่ไม่มีการสมัครสมาชิกที่ใช้งานอยู่จึงได้คำตอบ 402 เหมือนเดิมเสมอ แทนที่จะเป็นคำขอที่ทำไปได้ครึ่งทาง

  • ไม่มีการกล่าวถึงหมู่ ข้อความทุกข้อความที่ส่งผ่าน API (รวมถึงข้อความเว็บฮุกและแท็ก) ปิด @everyone, @here และการกล่าวถึงยศตามใจชอบไว้ ตอนเปิดทิกเก็ตจะกล่าวถึงได้เฉพาะยศที่ตั้งไว้ในแผงและคนที่เปิดทิกเก็ตเท่านั้น
  • ไม่มีการสวมรอย ชื่อที่เว็บฮุกแสดงซึ่งมีคำสงวนอย่าง "discord" หรือ "clyde" จะถูกเปลี่ยน และรูปโปรไฟล์ที่ใส่แทนต้องเป็นที่อยู่ https:// ที่ถูกต้อง
  • ต้องมี Premium API เป็นความสามารถของ Premium หากไม่มีการสมัครสมาชิกที่ใช้งานอยู่ ทุกคำขอจะคืนค่า 402 พร้อม premium_required: true และจะสร้างหรือเปลี่ยนโทเค็นใหม่ไม่ได้
  • ขีดจำกัดจำนวนคำขอ โทเค็นแต่ละอันถูกจำกัดแยกตามการกระทำ (เช่น เปิดทิกเก็ต 10 ครั้งต่อนาที ส่งข้อความ 30 ครั้งต่อนาที เปลี่ยนชื่อ 2 ครั้งต่อ 10 นาที เปลี่ยนแผง 2 ครั้งต่อ 10 นาที แก้ไขแผง 10 ครั้งต่อนาที ส่งแผงอีกครั้ง 4 ครั้งต่อ 10 นาที และการอ่าน 120 ครั้งต่อนาที) เมื่อเกินขีดจำกัดจะได้ 429 พร้อมค่า retry_after เป็นวินาที เรียก GET /api/token เพื่อดูตารางล่าสุด
  • การอ่านที่หนักมีขีดจำกัดแยกต่างหาก การค้นในบันทึกสนทนาและการดาวน์โหลดบันทึก HTML ได้อย่างละ 10 ครั้งต่อนาที ส่วนบันทึกฉบับเต็มที่จัดทำดัชนีแล้วได้ 30 ครั้งต่อนาที จึงไม่ไปกินโควตาการอ่าน 120 ครั้งต่อนาทีที่ให้มาอย่างเหลือเฟือ นอกจากนี้การค้นยังทำงานพร้อมกันได้มากที่สุดสองงานทั้งเซิร์ฟเวอร์ และจะหยุดด้วย 504 หากใช้เวลาเกินที่กำหนด การค้นจึงไม่แย่งทรัพยากรจากงานดูแลทิกเก็ต
  • เพดานทิกเก็ตที่เปิดอยู่ เมื่อเซิร์ฟเวอร์แตะเพดานความปลอดภัยของจำนวนทิกเก็ตที่เปิดอยู่ API จะไม่เปิดทิกเก็ตเพิ่ม และจะไม่เปิดทิกเก็ตให้ผู้ใช้ที่อยู่ในบัญชีดำเลย
  • ให้สิทธิ์เท่าที่จำเป็น สิทธิ์ที่อ่อนไหว (อ่านข้อความในทิกเก็ต ดูบันทึกสนทนา ค้นในบันทึกสนทนา ดาวน์โหลดบันทึก HTML ใช้แท็ก เปลี่ยนชื่อทิกเก็ต จัดการแผง และเปลี่ยนแผงของทิกเก็ต) ถูกปิดไว้เป็นค่าเริ่มต้น และต้องเปิดเองทีละโทเค็น
  • การอ่านข้อมูลย้อนหลังถูกตรวจสอบ การดาวน์โหลดบันทึก HTML ฉบับเต็มจะถูกเขียนลงบันทึกกิจกรรมของเซิร์ฟเวอร์พร้อมระบุโทเค็นที่ทำ เช่นเดียวกับทุกการเปลี่ยนแปลงที่ API ทำ
  • แผงยังผูกกับการตั้งค่าของคุณ สิทธิ์จัดการแผงเปลี่ยนได้เฉพาะหน้าตาของแผง (ชื่อ ข้อความฝัง ปุ่ม) ส่วนช่อง หมวดหมู่ ยศที่จะแจ้ง แบบฟอร์ม และทีมซัพพอร์ต เปลี่ยนผ่าน API ไม่ได้
  • วันหมดอายุและการเปลี่ยนโทเค็น โทเค็นตั้งวันหมดอายุได้ ปิดใช้ได้ หรือเปลี่ยนใหม่ได้จากแดชบอร์ด และการเปลี่ยนจะทำให้ค่าความลับเดิมใช้ไม่ได้ทันที
  • ผูกกับเซิร์ฟเวอร์เดียว โทเค็นทำงานได้เฉพาะในเซิร์ฟเวอร์ที่สร้างมันขึ้นมา และทุกคำขอจะถูกตรวจสอบกับเซิร์ฟเวอร์นั้นซ้ำอีกครั้ง