จัดการคีย์ API

เปิดใช้งานการตรวจสอบและอนุญาตการเข้าถึง API ด้วยการใช้ API คีย์ซึ่งช่วยให้คุณสามารถเพิ่มสิทธิ์และการควบคุมความปลอดภัยสําหรับการเข้าถึงและใช้ทรัพยากรบางอย่างในประสบการณ์ของคุณ เช่น คลังข้อมูลและสถานที่

API เปิดทั้งหมดในเมฆที่เปิดใช้งานต้องให้คุณสร้างคีย์ API ที่มีสิทธิ์ถูกต้องและรวมหัวข้อ x-api-key ในคำขอของคุณซึ่งช่วยให้แอปพลิเคชันสามารถรับรองต่อ Open Cloud ในนามของคุณได้

สร้างคีย์ API

คุณสามารถสร้างและกำหนดค่าคีย์ API สำหรับประสบการณ์ที่คุณเป็นเจ้าของเองหรือประสบการณ์ที่เป็นของกลุ่ม (กลุ่ม Roblox ช่วยให้ผู้สร้างหลายคนสามารถทำงานในประสบการณ์เดียวกัน ใช้ทรัพยากรเดียวกัน และแบ่งปันคีย์ API)

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

เพื่อสร้างคีย์ API:

1. นําทางไปยัง แดชบอร์ดผู้สร้าง

2. (เลือกได้) คลิกที่กล่องเลื่อนลง Creator Hub เพื่อเลือกกลุ่มหากคุณกําลังสร้างคีย์ API สําหรับกลุ่ม

3. ในเมนูการนําทางด้านซ้าย, เลือก เปิดคลาวด์ → คีย์ API

4. คลิกที่ปุ่ม สร้างคีย์ API

5. ใส่ชื่อที่ไม่ซ้ำกันสำหรับคีย์ API ของคุณใช้ชื่อที่สามารถช่วยให้คุณนึกถึงวัตถุประสงค์ในภายหลังได้ เช่น PLACE_PUBLISHING_KEY สำหรับการเผยแพร่สถานที่ให้ประสบการณ์ของคุณ

6. ในส่วน สิทธิ์การเข้าถึง เลือก API จากเมนู เลือกระบบ API และคลิกปุ่ม เพิ่มระบบ API ทำซ้ำขั้นตอนนี้หากต้องการเพิ่ม API หลายตัวให้กับกุญแจ

7. เลือกประสบการณ์ที่คุณต้องการเข้าถึงด้วยคีย์ API

8. จากกลุ่มเลื่อนลง การดำเนินการประสบการณ์ เลือกการดำเนินการที่คุณต้องการเปิดใช้งานสําหรับคีย์ API

   การดำเนินการจํานวนมากใน คําอธิบายของ API รวมถึงขอบเขตการอนุญาตที่จําเป็นตัวอย่างเช่นการดำเนินการ ล้างคลังหน่วยความจํา ต้องใช้สิทธิ์ universe.memory-store:flush

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

9. ในส่วน ความปลอดภัย กำหนดการเข้าถึง IP อย่างชัดเจนไปยังกุญแจโดยใช้ การบันทึก CIDR มิฉะนั้นคุณไม่สามารถใช้กุญแจ API ได้คุณสามารถค้นหาที่อยู่ IP ของเครื่องท้องถิ่นของคุณและเพิ่มลงในส่วน ที่อยู่ IP ที่ยอมรับ พร้อมกับที่อยู่ IP เพิ่มเติมสำหรับผู้ที่ต้องการเข้าถึงหากคุณไม่มี ทรัพย์สินทางปัญญาคงที่หรือคุณกำลังใช้กุญแจ API เฉพาะในสภาพแวดล้อมท้องถิ่นคุณสามารถเพิ่ม 0.0.0.0/0 ในส่วน ที่ยอมรับที่อยู่ IP เพื่ออนุญาตให้ IP ใด ๆ ใช้กุญแจ API ของคุณ

10. (ตัวเลือก) : เพื่อเพิ่มการป้องกันสําหรับทรัพยากรของคุณ ตั้งวันหมดอายุโดยเฉพาะเพื่อให้กุญแจหยุดทํางานหลังวันที่นั้นอัตโนมัติ

11. คลิกที่ปุ่ม บันทึกและสร้างกุญแจ

12. คัดลอกและบันทึกสตริงคีย์ API ไปยังตำแหน่งที่ปลอดภัยที่ไม่ใช่คลังเก็บรหัสสาธารณะของคุณ ไม่

13. ตรวจสอบคีย์ API ที่สร้างขึ้นบนหน้า การขยาย API ของ แดชบอร์ดผู้สร้าง

    สตริงคีย์ API เทียบเท่ากับรหัสผ่านของแอปพลิเคชันของคุณอย่าแชร์กับบุคคลที่ไม่เชื่อถือได้ เช่น ทุกคนนอกทีมพัฒนาของคุณ :

สิทธิ์การเข้าถึงคีย์ API ที่เป็นเจ้าของกลุ่ม

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

การให้สิทธิ์อนุญาต

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

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

การยกเลิกการอนุญาตไม่ถูกต้อง

มีหลายสถานการณ์ที่ยกเลิกสิทธิ์การจัดการกุญแจ API กลุ่มของสมาชิกกลุ่มโดยอัตโนมัติ:

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

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

รูปแบบ CIDR

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

• ปกติ : 192.168.0.0
• CIDR : 192.168.0.0/24

ส่วนก่อนหน้าคือที่อยู่ IP และส่วนหลังคือ netmask นับบิตของ 1 ในรูปแบบไบนารีในตัวอย่างก่อนหน้านี้ 24 หมายถึง 255.255.255.0 (24 1 วินาที) ที่อนุญาตให้ทุกไอพีระหว่าง 192.168.0.0 และ 192.168.0.255 การเข้าใจรูปแบบ CIDR เป็นประโยชน์อย่างยิ่งหากคุณวางแผนที่จะรันแอปพลิเคชันของคุณบนเซิร์ฟเวอร์

สถานะคีย์ API

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