วิธีใช้ Joomla Web Services API

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

❶ เตรียม Joomla ให้เรียก API ได้

① เปิด Web Services plugin

ในส่วนจัดการปลั๊กอินของ Joomla ให้เปิดปลั๊กอิน Web Services สำหรับข้อมูลที่ต้องการใช้งาน เช่น บทความในคอมโพเนนต์ com_content หากปลั๊กอินของคอมโพเนนต์นั้นปิดอยู่ endpoint ที่เกี่ยวข้องอาจเรียกไม่ได้

② เตรียม Token และสิทธิ์

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

❷ ทำความเข้าใจ URL และรูปแบบคำขอ

API หลักของ Joomla ใช้ทางเข้า /api/index.php และตามด้วยเวอร์ชันกับชื่อทรัพยากร ตัวอย่าง endpoint สำหรับรายการบทความคือ

https://example.org/api/index.php/v1/content/articles

เปลี่ยน example.org เป็นโดเมนเว็บไซต์ของคุณ หากติดตั้ง Joomla ไว้ในโฟลเดอร์ย่อย ให้ใส่ชื่อโฟลเดอร์นั้นไว้ก่อน /api ด้วย

คำขอที่ใช้บ่อย ได้แก่ GET สำหรับอ่านข้อมูล, POST สำหรับสร้างข้อมูล, PATCH สำหรับแก้ไข และ DELETE สำหรับลบข้อมูล ทั้งนี้ต้องตรวจสอบว่า endpoint รองรับวิธีนั้นและบัญชีมีสิทธิ์หรือไม่

❸ ทดลองอ่านรายการบทความ

เริ่มด้วย GET เพื่อดูว่าการเชื่อมต่อ การยืนยันตัวตน และสิทธิ์ทำงานถูกต้องหรือไม่ ตัวอย่างคำสั่งต่อไปนี้ใช้ curl และ Token ในรูปแบบตัวแปรแทนค่าจริง

API_BASE="https://example.org/api/index.php/v1"
JOOMLA_TOKEN="ใส่_API_Token_ของคุณ"

curl --request GET \
  --url "$API_BASE/content/articles" \
  --header "Accept: application/vnd.api+json" \
  --header "X-Joomla-Token: $JOOMLA_TOKEN"

หากสำเร็จ Joomla จะตอบกลับข้อมูล JSON โดยรายการข้อมูลจะอยู่ใน data ส่วนรายละเอียดของแต่ละรายการอาจมีชื่อบทความ หมวดหมู่ สถานะ และข้อมูลอื่นตาม endpoint และสิทธิ์ของบัญชี

❹ สร้างหรือแก้ไขข้อมูลอย่างระมัดระวัง

เมื่ออ่านข้อมูลได้แล้ว ค่อยทดลองสร้างหรือแก้ไขรายการบนเว็บทดสอบก่อน การส่งข้อมูลเพื่อเขียนโดยทั่วไปต้องระบุ Content-Type: application/json และส่งข้อมูลตามฟิลด์ที่ endpoint นั้นกำหนด

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

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

❺ ตรวจสอบข้อผิดพลาดและความปลอดภัย

หาก API ตอบกลับข้อผิดพลาด ให้ตรวจสอบรหัส HTTP และเนื้อหาคำตอบ โดยสาเหตุที่พบบ่อยมีดังนี้

  • 401 ไม่มี Token, Token ไม่ถูกต้อง หรือบัญชีไม่ได้รับอนุญาตให้เข้าสู่ API
  • 403 ยืนยันตัวตนแล้ว แต่ไม่มีสิทธิ์ทำรายการนั้น
  • 400 ข้อมูลที่ส่งไม่ครบหรือไม่ผ่านการตรวจสอบ
  • 404 URL หรือ endpoint ไม่ถูกต้อง หรือทรัพยากรที่ระบุไม่มีอยู่

ใช้ HTTPS กับเว็บไซต์จริง เก็บ Token ไว้ในฝั่งเซิร์ฟเวอร์หรือระบบจัดเก็บความลับ และห้ามฝัง Token ไว้ใน JavaScript หรือโค้ดที่ผู้เข้าชมมองเห็นได้ หากมีการเปิดคำขอจากอีกโดเมนหนึ่ง อาจต้องตั้งค่า CORS ให้เหมาะสม แต่ CORS ไม่ได้ทดแทน Token หรือสิทธิ์ API

❻ วางแผนใช้งานจริง

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

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