Open API **Add-On
ปัจจุบันทีมงานได้พัฒนาฟังก์ชันการใช้งาน Open API และได้จัดทำคู่มือการใช้งาน (API Documentation) เพื่อรองรับการดึงข้อมูลจากระบบ ByteHR ไปใช้งาน โดย Open API รองรับการส่งออกข้อมูลทั้งข้อมูลมาตรฐานของระบบและ Custom Fields ที่แอดมินกำหนดเอง
สำหรับบริษัทที่ต้องการใช้งาน Open API เพื่อดึงข้อมูลดิบจาก ByteHR สามารถติดต่อผ่านช่องทาง Support Chat เพื่อประสานงานขอเปิดใช้งาน Add-On Open API ได้
ดูคู่มือการใช้งาน ByteHR API Documentation ได้ที่ LEARN MORE
ราคาของฟีเจอร์ Open API จะขึ้นอยู่กับจำนวนพนักงานในแพ็คเกจของคุณลูกค้า และจะ Prorate ตามรอบการวางบิล โปรดติดต่อที่เบอร์โทร 02-026-3297 ต่อ 3 เพื่อสอบถามรายละเอียดเพิ่มเติมได้
Note 📝
Q1: Open API มีการจำกัดจำนวนการเรียกใช้งาน (request) หรือไม่
A1: มี ระบบจำกัดการเรียกใช้งานที่ 1,000 requests ต่อเดือน ต่อบริษัท / API Key
—
Q2: API Key มีวันหมดอายุหรือไม่
A2: มี API Key มีอายุการใช้งาน 1 ปี
หาก API Key หมดอายุ ผู้ใช้งานต้องทำการรีเซ็ต API Key ใหม่เพื่อใช้งาน Open API ต่อ
—
Q3: สามารถดึงข้อมูลได้สูงสุดกี่รายการต่อ 1 request
A3: ระบบรองรับการดึงข้อมูลสูงสุด 100 records ต่อ 1 request
โดยค่าเริ่มต้น (default) ระบบจะดึงข้อมูลให้ 10 records ต่อ request
—
Q4: ระบบรองรับการดึงข้อมูลแบบ Pagination หรือไม่
A4: รองรับ ผู้ใช้งานสามารถกำหนดจำนวนข้อมูลต่อหน้า และเลขหน้าที่ต้องการดึงได้ผ่าน query parameters
ตัวอย่าง:
https://developer.byte-hr.com/api/employees?limit=2¤tpage=4
limit คือ จำนวน records ต่อหน้า
currentpage คือ เลขหน้าที่ต้องการดึงข้อมูล
—
Q5: ทำไมดึงข้อมูลมาได้ไม่ครบทั้งหมด
A5: เนื่องจากระบบมีการจำกัดจำนวน records ต่อ 1 request
หากจำนวนข้อมูลทั้งหมดมากกว่าที่กำหนด ระบบจะส่งข้อมูลกลับมาเฉพาะตามจำนวน limit ที่ตั้งไว้
ผู้ใช้งานจำเป็นต้องเรียก API หลายครั้งโดยใช้ Pagination เพื่อดึงข้อมูลทั้งหมด
—
Q6: ถ้ามีข้อมูลทั้งหมด 100 records แต่ limit = 10 ระบบจะทำงานอย่างไร
A6: ระบบจะส่งข้อมูลกลับมาเฉพาะ 10 records แรก
หากต้องการข้อมูลที่เหลือ จำเป็นต้องเรียก API เพิ่มโดยเปลี่ยนค่า currentpage
—
Q7: เมื่อถึงจำนวน request สูงสุดต่อเดือน ระบบจะทำงานอย่างไร
A7: เมื่อใช้งานครบตามจำนวนที่กำหนด ระบบจะไม่สามารถเรียก Open API เพิ่มได้จนกว่าจะเริ่มรอบเดือนใหม่