Kunci API

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

Di mana kunci API diatur?

Navigasi ke Pengaturan > Organisasi > API Kunci di console.capgo.app/settings/organization/api-kunci.

Halaman ini menampilkan dua bagian:

• Kunci RBAC — Kunci yang telah diberikan peran (direkomendasikan). Kunci ini menggunakan sistem izin berbasis peran baru.
• Kunci Legacy — Kunci yang lebih tua yang menggunakan sistem mode sederhana (read, upload, write, all) tanpa pengaturan peran.

Bagaimana cara membuat kunci API baru?

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

2. Isi informasi Kunci:

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

3. Pilih peran Peran Organisasi — Ini menentukan izin dasar kunci di seluruh organisasi. 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. Pengelola
   • — Akses administratif penuh ke organisasi (mewarisi akses ke semua aplikasi). Jika kunci memerlukan pembuatan organisasi melalui __CAPGO_KEEP_0__ publik, aktifkan

4. If the key needs to create organizations through the public API, enable __CAPGO_KEEP_0__.

   Ini menambahkan izin global. org.create 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 izin akses per aplikasi:

   • Klik ”+ Tambahkan Aplikasi” untuk membuka pemilih aplikasi.
   • Pilih satu atau lebih aplikasi, kemudian tentukan peran untuk setiap aplikasi:
     • Pembaca Aplikasi — Akses baca-saja pada aplikasi.
     • Uploader Aplikasi — Dapat mengunggah bundle baru.
     • Pengembang Aplikasi — Dapat mengelola konfigurasi dan pengiriman aplikasi.
     • Pengelola Aplikasi — Akses penuh ke aplikasi.

6. Klik “Buat”.

7. Jika Anda memeriksa ‘Buat kunci aman’, akan muncul modal dengan kunci teks. Salin segera — tidak dapat diretrive setelah menutup modal.

Bagaimana mengelola (mengedit) kunci API?

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

• Ubah nama kunci Ubah nama kunci.
• Perbarui peran organisasi Aktifkan atau nonaktifkan.
• Izinkan membuat organisasi ketika kunci memiliki peran organisasi Admin. Tambahkan, hapus, atau ubah kunci organisasi.
• Tambahkan, hapus, atau ubah kunci organisasi. peran aplikasi.

Klik “Simpan Perubahan” ketika selesai.

Bagaimana cara menghasilkan ulang kunci API?

Untuk menghasilkan ulang nilai rahasia kunci API, klik ikon refresh (Regenerasi) pada kunci mana pun di daftar.

Tampilan konfirmasi akan muncul. Setelah mengkonfirmasi:

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

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

Bagaimana cara menghapus kunci API?

Klik ikon sampah (Hapus) pada kunci mana pun di daftar. Konfirmasikan penghapusan dalam dialog. Hapus kunci __CAPGO_KEEP_0__

Kunci tersebut dibatalkan segera — setiap permintaan yang menggunakan kunci tersebut akan gagal.

Kunci Legacy

Jika Anda melihat kunci di Kunci Legacy bagian (kunci tanpa penugasan peran), kunci tersebut menggunakan sistem izin berbasis mode yang lebih tua (”,). Kunci tersebut masih berfungsi, tetapi tidak mendapatkan manfaat dari RBAC hak istimewa izin yang lebih halus.read, upload, write, allKunci Legacy dapat diulangi dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan peran RBAC. Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci Legacy ketika memungkinkan.

Jika Anda perlu mengelola kunci Legacy secara langsung, Anda masih dapat mengaksesnya di

console.__CAPGO_KEEP_0__.app/dashboard/apikeys console.capgo.app/dashboard/apikeysKunci Legacy

Teruskan dari API Kunci

Jika Anda menggunakan API Kunci untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Ringkasan untuk detail implementasi di 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.