วิธีสร้าง API Token ใน Joomla

การสร้าง API Token ใน Joomla ต้องเปิดปลั๊กอินยืนยันตัวตนที่เกี่ยวข้อง กำหนดกลุ่มผู้ใช้และสิทธิ์ API จากนั้นสร้างหรือดู Token ในโปรไฟล์ของบัญชีที่จะใช้เชื่อมต่อ Token ใช้ยืนยันตัวตนของบัญชี แต่ไม่ได้ให้สิทธิ์ทำทุกอย่างโดยอัตโนมัติ

❶ เปิดปลั๊กอิน API Token

เข้าสู่ระบบหลังบ้าน Joomla แล้วตรวจสอบปลั๊กอินที่เกี่ยวข้อง โดยทั่วไปต้องเปิดใช้งานทั้ง

  • API Authentication – Web Services Joomla Token
  • User – Joomla API Token

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

❷ กำหนดกลุ่มผู้ใช้และสิทธิ์ API

① เลือกกลุ่มที่ได้รับอนุญาตให้ใช้ Token

เปิดการตั้งค่าปลั๊กอิน User – Joomla API Token แล้วกำหนดกลุ่มผู้ใช้ที่อนุญาตให้เห็นและใช้ส่วน API Token ในโปรไฟล์ เลือกเฉพาะกลุ่มที่จำเป็นต่อการเชื่อมต่อ

② อนุญาตให้กลุ่มเข้าสู่ระบบผ่าน API

ไปที่การตั้งค่าสิทธิ์ใน Global Configuration แล้วตรวจสอบสิทธิ์ Web Services Login สำหรับกลุ่มที่ต้องใช้ API นอกจากนี้ บัญชียังต้องมีสิทธิ์ของคอมโพเนนต์และรายการข้อมูลที่ต้องการจัดการด้วย

การอนุญาตกลุ่มในปลั๊กอิน Token กับสิทธิ์ Web Services Login เป็นคนละส่วน ต้องตรวจสอบทั้งสองจุด หากมีสิทธิ์ Denied ที่สืบทอดมาจากกลุ่มแม่ การตั้ง Allowed ในกลุ่มย่อยอาจไม่สามารถลบล้างได้

❸ สร้างหรือดู API Token ในโปรไฟล์

① เปิดโปรไฟล์ของบัญชีผู้ใช้

เข้าสู่ระบบด้วยบัญชีที่จะใช้เรียก API แล้วเปิดหน้าโปรไฟล์ของบัญชีนั้น ในส่วน Joomla API Token สามารถสร้าง Token หรือจัดการ Token ที่มีอยู่ได้ ทั้งนี้สิทธิ์ที่บัญชีมีจะเป็นตัวกำหนดว่าทำอะไรผ่าน API ได้

② เก็บ Token ไว้อย่างปลอดภัย

คัดลอก Token ไปเก็บในระบบจัดเก็บรหัสผ่านหรือพื้นที่เก็บความลับที่ทีมดูแลควบคุมได้ อย่าวาง Token ไว้ในบทความ แชตสาธารณะ โค้ด JavaScript หรือไฟล์ที่ผู้เข้าชมเว็บไซต์ดาวน์โหลดได้

Token เปรียบเสมือนข้อมูลรับรองของผู้ใช้ หากผู้อื่นได้ไป อาจเรียก API ในนามบัญชีนั้นได้ตามสิทธิ์ที่บัญชีได้รับ

❹ ทดสอบการใช้งาน Token

เมื่อเปิด Web Services plugin ของคอมโพเนนต์ที่ต้องการแล้ว ให้ทดลองเรียก API ผ่าน HTTPS โดยส่ง Token ในส่วนหัวของคำขอ เช่น X-Joomla-Token หรือรูปแบบ Bearer ที่ Joomla รองรับ

ทดสอบด้วยคำขออ่านข้อมูลก่อน แล้วตรวจสอบรหัสตอบกลับและข้อมูล JSON หากได้ข้อผิดพลาด ให้ตรวจตามลำดับนี้

  • Token ถูกต้องและยังไม่ถูกยกเลิกหรือไม่
  • ปลั๊กอินยืนยันตัวตนเปิดใช้งานอยู่หรือไม่
  • กลุ่มได้รับอนุญาตให้ใช้ Token และมีสิทธิ์ Web Services Login หรือไม่
  • Web Services plugin ของคอมโพเนนต์นั้นเปิดอยู่หรือไม่
  • บัญชีมีสิทธิ์เข้าถึงการกระทำหรือข้อมูลที่ร้องขอหรือไม่

❺ ยกเลิกหรือเปลี่ยน Token เมื่อจำเป็น

หากสงสัยว่า Token รั่วไหล หรือระบบที่เชื่อมต่อไม่ควรใช้งานต่อ ให้กลับไปยังส่วน Joomla API Token ในโปรไฟล์เพื่อยกเลิกหรือสร้าง Token ใหม่ จากนั้นอัปเดตข้อมูลรับรองในระบบภายนอก และตรวจสอบ Log เพื่อดูคำขอที่เกิดขึ้นก่อนยกเลิก

ComSiam แนะนำให้สร้าง Token แยกตามผู้ใช้หรือระบบเชื่อมต่อเท่าที่ทำได้ และให้สิทธิ์เท่าที่จำเป็น วิธีนี้ช่วยให้ระบุและยกเลิก Token ที่มีปัญหาได้ง่ายขึ้น หากไม่มีความจำเป็นต้องใช้ API ก็ไม่ควรเปิดสิทธิ์หรือสร้าง Token ทิ้งไว้