5 วิธีง่ายๆ ควบคุมการเข้าถึงเอกสาร API ใน Apidog

หลังจากที่คุณเขียนเอกสาร API ของคุณเสร็จสิ้นและพร้อมที่จะเผยแพร่ คำถามสำคัญที่เกิดขึ้นคือ: ใครควรจะสามารถดูเอกสารนี้ได้บ้าง?

เอกสารควรเป็นสาธารณะทั้งหมดหรือไม่? หรือจำกัดเฉพาะทีมภายในของคุณ? บางทีพันธมิตรภายนอกของคุณอาจต้องการเข้าถึง—แต่ไม่ใช่ทุกคน

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

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

1. สาธารณะ: ทุกคนสามารถดูได้

หาก API ของคุณเปิดให้ใช้งานสาธารณะ—เช่น Open API ของผลิตภัณฑ์ของคุณ—เพียงแค่ตั้งค่าการควบคุมการเข้าถึงเป็น "สาธารณะ" ใครก็ตามที่มีลิงก์สามารถดูเอกสารได้

เคล็ดลับมือโปร: Apidog ยังมี API Hub ซึ่งเป็นแพลตฟอร์มสไตล์ตลาดที่นักพัฒนาสามารถเรียกดูและค้นพบ API ได้ เผยแพร่เอกสารของคุณที่นั่นเพื่อเพิ่มการมองเห็นและการนำไปใช้

2. ป้องกันด้วยรหัสผ่าน: อุปสรรคง่ายๆ

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

การตั้งค่าง่ายดาย:

• เลือก “ป้องกันด้วยรหัสผ่าน”
• ตั้งรหัสผ่านด้วยตนเอง หรือให้ระบบสร้างให้
• แบ่งปันกับเพื่อนร่วมงานหรือพันธมิตร

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

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

3. รายการอนุญาต IP: จำกัดการเข้าถึงเครือข่ายเฉพาะ

หากทีมหรือพันธมิตรของคุณตั้งอยู่ในสำนักงานที่มีที่ตั้งคงที่ การอนุญาต IP (IP allowlisting) อาจเป็นทางเลือกที่ดีที่สุดของคุณ

ทำงานดังนี้:

• เฉพาะผู้ใช้จากที่อยู่ IP หรือช่วง IP ที่ระบุเท่านั้นที่สามารถเข้าถึงเอกสารได้
• IP ที่ไม่ได้รับอนุญาตจะถูกปฏิเสธโดยอัตโนมัติ

ลองนึกภาพว่ามันเป็นไฟร์วอลล์สำหรับเอกสารของคุณ

เหมาะที่สุดสำหรับ:

• สภาพแวดล้อมองค์กร
• การจำกัดการเข้าถึงเครือข่ายภายในของคุณ
• การอนุญาตให้พันธมิตรเข้าถึงได้เฉพาะจากเครือข่ายสำนักงานของพวกเขาเท่านั้น

คุณสามารถกำหนดค่า IP เดียวหรือช่วง IP ทั้งหมดได้

โบนัส: คุณยังสามารถเปิดใช้งานการอนุญาต IP สำหรับ **การเข้าถึงโปรเจกต์ทีม** ใน **การตั้งค่าทีม** ของ Apidog (ต้องใช้ แพ็กเกจ Enterprise) เมื่อเปิดใช้งานแล้ว เฉพาะผู้ใช้จาก IP ที่ได้รับอนุญาตเท่านั้นที่สามารถเข้าถึงโปรเจกต์ภายในของคุณได้

4. รายการอนุญาตอีเมล: การเข้าถึงตามตัวตน

กังวลว่ารหัสผ่านอาจรั่วไหล หรือ IP อาจเปลี่ยนแปลงบ่อยหรือไม่? **การอนุญาตอีเมล (Email allowlisting)** เป็นทางเลือกที่ยืดหยุ่นและปลอดภัย

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

ยังรองรับ **Wildcard** ด้วย—ตัวอย่างเช่น *@apidog.com อนุญาตให้ผู้ใช้ทุกคนที่มีโดเมนของบริษัทของคุณเข้าถึงเอกสารได้

ประโยชน์:

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

5. หน้าเข้าสู่ระบบที่กำหนดเอง: รวมเข้ากับระบบยืนยันตัวตนของคุณเอง

หากวิธีการข้างต้นไม่ตอบสนองความต้องการของคุณ ยังมีตัวเลือกขั้นสูงกว่านั้น—หน้าเข้าสู่ระบบที่กำหนดเอง สิ่งนี้ช่วยให้คุณสามารถเชื่อมต่อระบบยืนยันตัวตนของคุณเองเพื่อควบคุมการเข้าถึงได้

วิธีการทำงานมีดังนี้:

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

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

ตรวจสอบ เอกสารช่วยเหลือ สำหรับรายละเอียดเกี่ยวกับการใช้งานหน้าเข้าสู่ระบบที่กำหนดเอง

วิธีเลือกวิธีการควบคุมการเข้าถึงที่เหมาะสม

ด้วยตัวเลือกมากมาย คุณอาจสงสัยว่า: ฉันควรเลือกอันไหนดี?

ขึ้นอยู่กับกรณีการใช้งานของคุณ:

เคล็ดลับ: คุณสามารถรวมหลายวิธีเข้าด้วยกันได้ ตัวอย่างเช่น:

• ใช้ รายการอนุญาต IP สำหรับสมาชิกทีมภายใน
• ใช้ รายการอนุญาตอีเมล สำหรับพันธมิตรภายนอก
• ใช้ การป้องกันด้วยรหัสผ่าน สำหรับการสาธิตชั่วคราว

ด้วย Apidog คุณสามารถ เผยแพร่ไซต์เอกสารหลายแห่ง โดยแต่ละแห่งมีการควบคุมการเข้าถึงของตัวเองและชุดปลายทาง API ที่ปรับแต่งได้ นั่นหมายความว่าผู้ชมที่แตกต่างกันจะเห็นเฉพาะสิ่งที่พวกเขาต้องการ—ไม่มากไปกว่านั้น ไม่น้อยไปกว่านั้น