เอกสาร

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

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

13.1

การยืนยันตัวตน

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

การสร้างโทเค็น

  • เปิดใช้ Premium ให้เซิร์ฟเวอร์จากหน้า Premium (หน้าการเข้าถึง API มีลิงก์ไปตรงนั้น)
  • เปิดแถบข้างของเซิร์ฟเวอร์แล้วไปที่ การเข้าถึง API
  • ตั้งชื่อโทเค็น (เช่น "บอทซัพพอร์ต" หรือ "เชื่อมกับ CRM")
  • กด สร้างโทเค็น แล้วคัดลอกค่าที่แสดงขึ้นมา
  • เก็บไว้ในที่เก็บความลับ เพราะเมื่อปิดข้อความแจ้งไปแล้วจะดูอีกไม่ได้

หาก Premium หมดอายุ

โทเค็นของคุณจะไม่ถูกลบ ทุกคำขอ API จะเริ่มคืนค่า 402 พร้อม premium_required: true และการสร้างหรือเปลี่ยนโทเค็นจะถูกระงับจนกว่าการสมัครสมาชิกจะกลับมาใช้งานได้ ส่วนการดูรายการ ปิดใช้ และเพิกถอนโทเค็นยังทำได้ตามปกติ คุณจึงจัดระเบียบได้อยู่ดี ในระบบของคุณให้จัดการ 402 แบบเดียวกับ 401 คือหยุดลองใหม่แล้วแจ้งให้คนดูแลทราบ

การตอบกลับเมื่อเซิร์ฟเวอร์ไม่มี Premium
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

การเพิกถอนโทเค็นทำให้โทเค็นใช้ไม่ได้ทันทีในทุกปลายทาง หากรับการหยุดชะงักไม่ได้ ให้สร้างโทเค็นใหม่ไว้ก่อน

การใช้โทเค็น

ส่งโทเค็นเป็นส่วนหัว Bearer ในทุกคำขอ ทุกคำขอมีผลเฉพาะกับเซิร์ฟเวอร์ที่สร้างโทเค็นนั้นขึ้นมา

ตัวอย่างคำขอที่ยืนยันตัวตนแล้ว
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets