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

ภาพรวม

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

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

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

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

รายละเอียด

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

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

สามารถดึงรายการคู่มือที่ลงทะเบียนไว้ได้
การเรียกแต่ละครั้งสามารถดึงข้อมูลได้สูงสุด 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 ได้ ในทางทฤษฎีสามารถเชื่อมต่อได้อย่างกว้างขวาง ไม่ว่าจะเป็นระบบที่พัฒนาเอง, แชทบอทสำเร็จรูป หรือเครื่องมือ 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. ไม่ ไม่รองรับ
ผู้ใช้งานสามารถค้นหาและอ้างอิงข้อมูลคู่มือจาก AI สร้างเนื้อหาได้ โดยการสร้างและติดตั้งโปรแกรมที่เรียก API ในระบบหรือ AI สร้างเนื้อหาที่ใช้งานอยู่ฝั่งผู้ใช้งาน