ขอทราบข้อมูลเกี่ยวกับ API ที่ให้บริการใน Teachme Biz

ภาพรวม

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

แพ็กเกจที่รองรับ

สำหรับแพ็กเกจสัญญาและออปชันเสริมที่สามารถใช้ฟีเจอร์นี้ได้ โปรดดูที่ลิงก์

• ฟีเจอร์ที่ใช้ได้ในแต่ละแพ็กเกจสัญญามีอะไรบ้าง
• วิธีตรวจสอบแพ็กเกจสัญญาและออปชันเสริม

รายละเอียด

ข้อมูลที่ดึงได้ผ่าน API คือข้อมูลข้อความของคู่มือที่กำลังเผยแพร่
ไม่สามารถสร้าง แก้ไข หรือลบคู่มือผ่าน API ได้

API รายการคู่มือ

สามารถดึงรายการคู่มือที่ลงทะเบียนไว้ได้
การเรียกใช้ครั้งละ 1 ครั้งสามารถดึงข้อมูลได้สูงสุด 100 รายการ
สามารถดึงคู่มือทั้งหมดได้โดยเรียกหน้าถัดไปเพื่อดูข้อมูลที่เหลือ
หากระบุคีย์เวิร์ด ระบบจะดึงคู่มือที่เกี่ยวข้องได้สูงสุด 100 รายการ เรียงตามความเกี่ยวข้องสูงสุด (ไม่มีหน้าถัดไป)
ข้อมูลที่ดึงได้ต่อคู่มือ ได้แก่ ID คู่มือ, URL, ชื่อเรื่อง, คำอธิบายปก และโฟลเดอร์ที่คู่มืออยู่

API รายละเอียดคู่มือ

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

ข้อมูลที่ดึงได้

• ID คู่มือ, URL ของคู่มือ
• ชื่อเรื่อง, คำอธิบายปก
• ชื่อขั้นตอน, คำอธิบายขั้นตอน (เฉพาะ API รายละเอียดคู่มือเท่านั้น)
• ชื่อฟิลด์และเนื้อหาที่กรอกของฟิลด์กำหนดเองของปกและขั้นตอน (เฉพาะ API รายละเอียดคู่มือเท่านั้น)
• ชื่อและลำดับชั้นของโฟลเดอร์ที่คู่มืออยู่

ข้อมูลที่ดึงไม่ได้

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

ลิงก์ที่เกี่ยวข้อง

การออกและลบ Client ID สำหรับการเชื่อมต่อ API (Web Browser)

Teachme Biz API Access Plus ข้อกำหนดเพิ่มเติม

ภาษาญี่ปุ่น：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms.pdf
ภาษาอังกฤษ：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_supplemental_terms_e.pdf

คำถามที่พบบ่อย

Q. สามารถเชื่อมต่อกับเครื่องมือภายนอกประเภทใดได้บ้าง?

A. หากเป็นระบบที่สามารถเรียกใช้และรับ API ได้ ในทางทฤษฎีแล้วสามารถเชื่อมต่อได้อย่างกว้างขวาง ไม่ว่าจะเป็นระบบที่พัฒนาขึ้นเอง แชทบอทสำเร็จรูป หรือเครื่องมือ Generative AI เป็นต้น

Q. มีข้อจำกัดในข้อมูลที่ดึงได้ผ่าน API หรือไม่?

A. ใช่
ข้อมูลที่ดึงได้จะอยู่ในขอบเขตที่ผู้ใช้ที่ออก API Key สามารถดูได้
ไม่สามารถดึงคู่มือที่ผู้ใช้ที่ออก API Key ไม่มีสิทธิ์ดูได้

Q. สามารถตั้งวันที่ครบกำหนดให้กับ API Key ที่ออกหรือการตั้งค่าการเชื่อมต่อได้หรือไม่?

A. สามารถตั้งวันที่ครบกำหนดได้หลายระดับ และยังสามารถตั้งเป็นไม่มีกำหนดได้อีกด้วย
อย่างไรก็ตาม โปรดทราบว่าหากผู้ใช้ที่ออก API Key ถูกลบออกจากกรุ๊ป การเชื่อมต่อจะหยุดทำงาน
เพื่อป้องกันการหยุดทำงานของการเชื่อมต่อ API โดยไม่ตั้งใจ เราแนะนำให้สร้างผู้ใช้เฉพาะสำหรับการออก API Key

Q. สามารถตั้ง API Key หลายรายการในระบบของตนเองได้หรือไม่?

A. ใช่
ตัวอย่างเช่น สามารถออก API Key ที่กำหนดขอบเขตการค้นหาคู่มือตามแผนก และเชื่อมต่อกับแต่ละระบบได้

Q. ภายใต้การจำกัด IP Address สามารถใช้ API ค้นหาคู่มือจากเครือข่ายที่ไม่ได้รับอนุญาตได้หรือไม่?

A. ใช่
API ไม่ได้รับผลกระทบจากการจำกัด IP Address

Q. หากดึงข้อมูลคู่มือผ่าน API จะถูกนับเป็นจำนวนการดูของคู่มือนั้นหรือไม่?

A. ไม่
การค้นหาและดึงข้อมูลคู่มือผ่าน API จะไม่ถูกนับเป็นจำนวนการดูของคู่มือ

Q. สามารถรับการสนับสนุนทางเทคนิคในการติดตั้งได้หรือไม่?

A. สำหรับการเชื่อมต่อกับระบบ จำเป็นต้องดำเนินการจากฝั่งลูกค้าเอง

Q. รองรับ MCP (Model Context Protocol) หรือไม่?

A. ไม่ ไม่รองรับ
ผู้ใช้สามารถค้นหาและอ้างอิงข้อมูลคู่มือจาก Generative AI ได้ โดยการสร้างและติดตั้งโปรแกรมสำหรับเรียกใช้ API ในระบบหรือ Generative AI ที่ใช้งานอยู่จากฝั่งผู้ใช้เอง