เชื่อมต่อเครื่องมือของคุณด้วย API
API ช่วยให้แอปพลิเคชันภายนอกเข้าถึงข้อมูลขององค์กรของคุณได้ด้วยการเขียนโปรแกรม ไม่ว่าจะเป็นข้อมูลสมาชิก ปฏิทิน การจอง และการเรียกเก็บเงิน เปิดใช้งานได้ด้วยการคลิกเพียงสองครั้ง และป้องกันด้วยคีย์ รายการที่อยู่ IP ที่อนุญาต และการติดตามปริมาณการใช้งาน
ทราบว่า API เหมาะกับคุณหรือไม่
API มีไว้สำหรับนักพัฒนา ไม่ใช่สำหรับผู้ดูแลองค์กร โดยใช้เพื่อให้บัญชีของคุณสื่อสารกับซอฟต์แวร์ที่คุณให้เขียนขึ้นหรือตั้งค่าไว้ เช่น เว็บไซต์ที่ทำขึ้นเฉพาะ เครื่องมือบัญชี จอแสดงผลที่ทำขึ้นเอง หรือช่องทางเชื่อมต่อไปยังระบบอื่น
สำหรับความต้องการทั่วไป เช่น การดึงรายชื่อสมาชิก การอัปเดตการสมัครสมาชิกจำนวนมาก หรือการส่งตัวเลขให้คณะกรรมการ โมดูลนำเข้า ส่งออก และรายงานตอบโจทย์ได้โดยไม่ต้องเขียนโค้ดแม้แต่บรรทัดเดียว
API ให้บริการในรุ่นเบต้า การทำงานของ API จึงอาจเปลี่ยนแปลงได้อีก
เปิดใช้งาน API และรับคีย์ของคุณ
- ไปที่ การจัดการ›การตั้งค่า›API BETA
- เปิดใช้งาน เปิดใช้งานโมดูล API แล้วคลิก บันทึก
- คีย์ API ของคุณจะแสดงขึ้น ให้คัดลอกด้วยปุ่ม คัดลอก และส่งต่อให้เฉพาะเครื่องมือที่คุณกำลังเชื่อมต่อเท่านั้น
คีย์จะถูกส่งไปในส่วนหัว HTTP X-API-Key ของทุกคำขอ การเรียกใช้ต้องทำผ่าน HTTPS เท่านั้น ระบบไม่รับคำขอที่ไม่ได้เข้ารหัส
ปกป้องคีย์
มีข้อควรปฏิบัติบางอย่างที่ควรย้ำกับเครื่องมือหรือผู้ให้บริการที่ใช้คีย์นี้
- ห้ามใส่คีย์ไว้ในคลังเก็บโค้ดโดยเด็ดขาด ให้เก็บไว้ในไฟล์ตั้งค่าที่อยู่นอกคลังเก็บโค้ด หรือในระบบจัดการข้อมูลลับ
- จำกัดที่อยู่ IP ที่อนุญาตทันทีที่เครื่องมือเรียกใช้จากเซิร์ฟเวอร์ที่มีที่อยู่คงที่
- สร้างคีย์ใหม่ทันทีที่มีข้อสงสัย เช่น การเผยแพร่โดยไม่ตั้งใจ บันทึกการทำงานรั่วไหล หรือสิ้นสุดงานของผู้ให้บริการ
ปุ่ม สร้างใหม่ จะขอให้ยืนยัน แล้วยกเลิกคีย์เดิมทันที แอปพลิเคชันทั้งหมดที่ใช้คีย์เดิมจะหยุดทำงานจนกว่าจะได้รับคีย์ใหม่ ดังนั้นควรแจ้งให้ทราบก่อนคลิก
จำกัดการเข้าถึงตามที่อยู่ IP
เปิดใช้งาน ข้อจำกัดตามที่อยู่ IP ระบบจะรับเฉพาะคำขอที่มาจากที่อยู่ที่คุณระบุไว้ โดยกำหนดได้ไม่เกิน 10 ที่อยู่ IPv4 กรอกแต่ละที่อยู่แล้วยืนยันด้วย เพิ่ม ทั้งนี้ที่อยู่ปัจจุบันของคุณจะแสดงบนหน้าจอเพื่อช่วยคุณ
นี่คือการป้องกันที่มีประสิทธิภาพที่สุด และมักถูกมองข้ามที่สุด เพราะแม้คีย์จะรั่วไหล คีย์ที่จำกัดไว้เฉพาะที่อยู่ของผู้ให้บริการของคุณก็ยังใช้จากที่อื่นไม่ได้
ติดตามปริมาณการใช้งาน
หน้าจอจะแสดงปริมาณการใช้งานของคีย์ของคุณอย่างต่อเนื่อง
- การใช้งานในนาทีนี้ และ การใช้งานวันนี้ โดยแต่ละรายการจะเทียบกับขีดจำกัดของตัวเองเมื่อมีการตั้งขีดจำกัดไว้
- สถิติการใช้งาน : สัปดาห์นี้, เดือนนี้, รวม และ คำขอล่าสุด
เมื่อเกินขีดจำกัดที่ระบุไว้ คำขอที่เพิ่มเข้ามาจะถูกปฏิเสธชั่วคราว ตัวนับที่แตะเพดานอยู่ตลอดเวลามักบ่งชี้ว่าเครื่องมือถูกตั้งค่าไม่เหมาะสม เพราะขอข้อมูลชุดเดิมซ้ำ ๆ แทนที่จะเก็บไว้ในแคช
วันที่ของคำขอครั้งล่าสุดมีประโยชน์ในทางกลับกัน คีย์ที่เปิดใช้งานไว้แต่ไม่มีการเรียกใช้เลยเป็นเวลาหลายเดือน คือคีย์ที่ควรปิดใช้งาน
ดูว่า API ทำอะไรได้
เอกสารประกอบฉบับเต็ม พร้อมพารามิเตอร์และตัวอย่างการเรียกใช้ แสดงอยู่ที่ด้านล่างของหน้าจอโมดูล โดยสรุปได้ดังนี้
- ผู้ใช้ : เป็นทรัพยากรเดียวที่แก้ไขได้ คุณสามารถแสดงรายการ ดูรายละเอียด สร้าง แก้ไข และลบบัญชีได้
- การตั้งค่า : การสมัครสมาชิก โปรไฟล์ กลุ่ม และหมวดอายุ สามารถดูได้ แต่ตั้งค่าได้จากในแอปพลิเคชันเท่านั้น
- การจอง : ปฏิทิน ช่วงเวลาที่ว่าง การจอง และป้ายกำกับ สามารถดูได้
- การเรียกเก็บเงิน : บัญชีเรียกเก็บเงิน คำสั่งซื้อ และการชำระเงิน สามารถดูได้
