Mengelola Kunci API

Buka Cloud menyetujui dan menyetujui akses API dengan menggunakan kunci API, yang memungkinkan Anda untuk menambahkan izin granular dan kontrol keamanan untuk akses ke sumber daya tertentu dalam pengalaman Anda, seperti penyimpanan data dan tempat.

Semua API Open Cloud mengharuskan Anda untuk membuat kunci API dengan izin yang valid dan mencakup header x-api-key dalam permintaan Anda, yang memungkinkan aplikasi untuk mengautentikasi ke Open Cloud atas nama Anda.

Membuat Kunci API

Anda dapat menciptakan dan mengkonfigurasi kunci API untuk pengalaman Anda yang dimiliki secara individual atau pengalaman dimiliki kelompok (A Roblox grup mengizinkan lebih dari satu pembuat untuk bekerja pada pengalaman yang sama, menggunakan sumber daya yang sama, dan berbagi kunci API).

Anda harus menjadi pemilik grup atau ditugaskan ke peran dalam grup yang memiliki izin API ke manajer untuk menciptakan API key untuk grup Anda. Seorang anggota grup hanya dapat menciptakan API key dengan akses ke sumber daya yang sama dengan izin akses peran mereka. Misalnya, hanya anggota grup dengan izin Buat dan ubah pengalaman grup dapat menciptakan API

Untuk menciptakan kunci API:

1. Navigasikan ke Dashboard Pencipta.

2. (Opsional) Klik tombol Pusat Pencipta untuk menyeleksi kelompok jika Anda menciptakan kunci API untuk grup.

3. Di menu navigasi kiri, pilih Buka Cloud → Kunci API .

4. Klik tombol Buat Kunci API .

5. Masukkan nama unik untuk API Anda. Gunakan nama yang dapat membantu Anda mengingat tujuan nanti, seperti PLACE_PUBLISHING_KEY untuk mempublikasikan tempat ke pengalaman Anda.

6. Dalam bagian Ijin Akses , pilih API dari menu Pilih Sistem API dan klik tombol Tambahkan Sistem API . Ulangi langkah ini jika Anda perlu menambahkan beberapa API ke unit.

7. Pilih pengalaman yang ingin Anda unitdengan kunci API.

8. Dari dropdown Operasi Pengalaman , pilih operasi yang ingin Anda aktifkan untuk kunci API.

   Banyak operasi di referensi API termasuk scope izin yang diperlukan. Misalnya, operasi penyimpanan memori bersihkan mengharuskan scope izin universe.memory-store:flush.

   Untuk alasan keamanan, berikan setiap kunci API jumlah minimum izin yang dibutuhkan. Jika kunci API bocor, prinsip paling sedikit privasi menjamin bahwa hanya subaset sumber daya Anda yang dikompromikan.

9. Dalam bagian Keamanan, secara eksplisit tetapkan akses IP ke kunci menggunakan notasi CIDR, jika tidak, Anda tidak dapat menggunakan kunci API. And

10. (Opsional) : Untuk menambahkan perlindungan tambahan untuk sumber daya Anda, tetapkan tanggal kedaluwarsa yang jelas sehingga kunci Anda secara otomatis berhenti bekerja setelah tanggal itu.

11. Klik tombol Simpan dan Hasilkan kunci .

12. Salinan dan simpan string API ke lokasi yang aman yang bukan bukan repositorium publik dari kode Anda.

13. Periksa kunci API yang Anda buat di halaman Kredit dari Papan Masa Pembuat .

Izinkan API Keanggotaan Grup

Pemilik grup dapat mengelola izin API milik grup bagi anggota grup untuk memiliki tingkat kontrol yang berbeda dari kunci API berdasarkan peran dan izin di dalam grup. Ada juga situasi di mana API key manajemen izin secara otomatis dihapus dari izin manajemen API bagi anggota grup.

Pengizinan Memberikan

Sebagai pemilik grup, Anda dapat memberikan izin Manage all API keys kepada peran di dalam grup Anda. Member dengan izin ini memiliki semua izin yang dimiliki seorang pemilik grup untuk API keys, termasuk kemampuan untuk menciptakan, melihat, batalkan, menarik kembali, dan mengaudit semua API keys grup.

Anda juga dapat memberikan izin Manage own API keys kepada peran di dalam grup Anda. Ini memungkinkan anggota hanya untuk membuat dan menampilkan kunci yang dimiliki mereka, bukan dapat menangani kunci orang lain.

Penghapusan Izin

Ada beberapa situasi di mana izin anggota grup secara otomatis dihapus untuk mengelola kunci API grup:

• Anggota diberikan ke peran yang berbeda yang tidak memiliki izin. Ini dapat terjadi selama transfer kepemilikan kelompok.
• Izin anggota di nonaktifkan pada peran yang mereka miliki saat ini.
• Anggota meninggalkan atau dihapus dari grup.
• Akun anggota di bawah moderasi oleh Roblox.

Dalam salah satu dari kasus ini, kunci API yang dihasilkan oleh pengguna itu diberi status Dibatalkan . Untuk menggunakan kunci ini lagi, pemilik grup atau anggota dengan izin Manage all API keys harus meregenerasi kunci.

Format CIDR

Untuk melindungi sumber daya Anda lebih lanjut, ketika membuat kunci API, spesifikasi alamat IP yang dapat mengakses kunci API dengan kode IP normal atau menggunakan notasi CIDR . Sebuah alamat IP CIDR terlihat seperti alamat IP normal kecuali berakhir dengan slash dan angka desimal yang mewakili berapa banyak bit dari alamat IP yang signifikan untuk rute jaringan:

• Normal : 192.168.0.0
• CIDR : 192.168.0.0/24

Bagian yang pertama adalah alamat IP dan bagian yang terakhir adalah netmask , menghitung bit dari 1s dalam format binaya. Pada contoh sebelumnya, 24 berarti 255.2

Status Kunci API

Kunci API awalnya memiliki status aktif, tetapi mereka dapat menjadi tidak aktif selama hidup mereka. Untuk belajar mengapa kunci API telah berubah status dan cara mengembalikan kunci API ke status aktif, lihat tabel berikut.

Jika Anda atau grup Anda tidak menggunakan atau menyetujui kunci API selama 60 hari, itu secara otomatis kedaluwarsa, bahkan jika tidak memiliki tanggal kedaluwarsa yang ditetapkan. Ini mengurangi risiko penyalahgunaan kunci API lama oleh aktor jahat. Jika Anda tidak menggunakan unitAPI lagi, Anda harus secara manual menonaktifkan atau menghapusnya. If you or your group