API Kunci

Kunci API diatur pada tingkat organisasi dengan kontrol akses berdasarkan peran (RBAC). Setiap kunci dapat diberikan peran organisasi dan peran aplikasi opsional, memberikan Anda kontrol yang halus atas apa yang dapat diakses oleh setiap kunci.

Di mana kunci API diatur?

Navigasikan ke Pengaturan > Organisasi > Kunci API di konsol.capgo.app/settings/organization/api-keys.

Halaman menampilkan dua bagian:

• Kunci RBAC — Kunci dengan peran yang ditugaskan (direkomendasikan). Kunci ini menggunakan sistem izin berdasarkan peran baru.
• Kunci Legacy — Kunci-kunci yang lebih tua yang menggunakan sistem mode sederhana (read, upload, write, all) tanpa penugasan peran.

Bagaimana cara membuat kunci API baru?

1. Klik tombol ”+” di atas tabel kunci RBAC.

2. Isi informasi Kunci informasi:

   • Nama (wajib) — Label deskriptif untuk kunci (misalnya “Deploy CI/CD”, “Monitoring Baca-Saja”).
   • Buat kunci aman (opsional) — Ketika centang, kunci akan di-hash di sisi server. Kunci teks biasa ditampilkan hanya sekali setelah pembuatan. Anda tidak akan dapat mengambilnya kembali. hanya sekali setelah pembuatan. Anda tidak akan dapat mengambilnya kembali.
   • Atur tanggal kadaluarsa (opsional) — Pilih tanggal setelah mana kunci akan berhenti berfungsi. Beberapa organisasi mewajibkan kadaluarsa wajib melalui kebijakan.

3. Pilih Peran Organisasi — Ini menentukan izin dasar kunci di seluruh organisasi. Peran-peran tersedia (tergantung pada tingkat peran Anda):

   • Tidak Ada — Tidak ada akses organisasi; kunci hanya memiliki akses ke aplikasi yang ditugaskan secara individu.
   • Anggota — Akses baca dasar ke organisasi.
   • Admin — Akses administratif lengkap ke organisasi (mewarisi akses ke semua aplikasi).

4. Jika kunci perlu membuat organisasi melalui publik API, aktifkan Izinkan membuat organisasi.

   Ini menambahkan global org.create izin. Tersedia ketika kunci memiliki peran organisasi Admin. Ketika kunci ini membuat organisasi baru, Capgo secara otomatis menugaskan kunci sebagai Super Admin pada organisasi baru tersebut.

5. Jika peran org yang dipilih bukan Admin, Anda dapat menambahkan akses per aplikasi:

   • Klik ”+ Tambah Aplikasi” untuk membuka pemilih aplikasi.
   • Pilih satu atau lebih aplikasi, kemudian tentukan peran untuk setiap aplikasi:
     • App Reader — Akses baca-saja ke aplikasi.
     • App Uploader — Dapat mengunggah bundle baru.
     • App Developer — Dapat mengelola konfigurasi dan pengiriman aplikasi.
     • App Admin — Akses penuh ke aplikasi.

6. Klik “Buat”.

7. Jika Anda memeriksa “Buat kunci aman”, maka modal akan menampilkan kunci teks. Salin segera — tidak dapat diretrive setelah menutup modal.

Bagaimana mengelola (mengedit) kunci API?

Klik ikon sengkang (Kelola) pada setiap kunci RBAC di daftar. Ini membuka halaman detail kunci di mana Anda dapat:

• Mengubah nama kunci Mengupdate kunci.
• Mengubah kunci peran organisasi.
• Aktifkan atau nonaktifkan Izinkan membuat organisasi ketika kunci memiliki peran organisasi Admin.
• Tambah, hapus, atau ubah peran organisasi per aplikasi.

Klik “Simpan Perubahan” ketika selesai.

Bagaimana cara menghasilkan kunci API baru?

Untuk menghasilkan kembali nilai rahasia dari sebuah API kunci, klik ikon refresh (Regenerasi) pada kunci apapun di daftar.

Konfirmasi dialog akan muncul. Setelah mengonfirmasi:

• Untuk kunci yang aman (dihash): Kunci teks biasa baru dihasilkan dan ditampilkan sekali dalam modal. Salinlah segera.
• Untuk kunci biasa: Nilai kunci dihasilkan ulang di server.

Integrasi apa pun yang menggunakan nilai kunci lama akan berhenti berfungsi segera.

Bagaimana cara menghapus kunci API?

Klik ikon trash icon (Hapus) pada kunci mana pun di daftar. Konfirmasikan penghapusan di dialog.

Kunci dihapus segera — setiap permintaan menggunakan kunci tersebut akan gagal.

Kunci Legacy

Jika Anda melihat kunci di Legacy Keys bagian (kunci tanpa penugasan peran), kunci-kunci tersebut menggunakan sistem izin berbasis mode yang lebih tua (read, upload, write, allMereka masih berfungsi, tetapi tidak mendapatkan manfaat dari RBAC hak istimewa izin.

Kunci lama dapat diregenerasi dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan RBAC peran.

Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci lama ketika memungkinkan. console.capgo.app/dashboard/apikeysconsole.__CAPGO_KEEP_0__.app/dashboard/apikeys

Keep going from API Keys

Judul bagian “Teruskan dari __CAPGO_KEEP_0__ Kunci” API Keys API Kunci untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Ringkasan Pengenalan untuk detail implementasi di Pengenalan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Perangkat, dan Bundel untuk detail implementasi di Bundel.