API Kunci

API menggunakan kontrol akses berdasarkan peran (RBAC). Sebuah kunci dapat memiliki peran organisasi luas, pengikat aplikasi, atau keduanya. Setiap pengikat aplikasi tetap terkait dengan organisasi yang menguasai aplikasi tersebut. Untuk kebijakan keamanan terendah, batasi kunci ke aplikasi tertentu daripada menetapkan peran organisasi luas.

Di mana API kunci-kunci ini dikelola?

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

Halaman menampilkan dua bagian:

• Kunci RBAC – Kunci dengan peran yang ditetapkan (direkomendasikan). Kunci-kunci ini menggunakan sistem izin berbasis peran baru.
• Kunci Legacy — Kunci-kunci yang lebih tua 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 Nama:

   • (wajib) — Label deskriptif untuk kunci (misalnya, “Deploy CI/CD” atau “Monitoring Baca-Saja”). button at the top of the RBAC keys table.
   • Membuat kunci yang aman (opsional) — Ketika centang, kunci di-hash di sisi server. Kunci teks biasa hanya ditampilkan sekali saja. sekali saja setelah pembuatan dan tidak dapat diperoleh lagi.
   • Atur tanggal kadaluarsa (opsional) — Pilih tanggal setelah mana kunci tidak berfungsi lagi. Beberapa organisasi mewajibkan tanggal kadaluarsa melalui kebijakan.

3. Pilih ruang lingkup kunci:

   • Akses organisasi secara keseluruhan — Pilih peran untuk menentukan izin dasar di seluruh organisasi. Peran yang tersedia tergantung pada tingkat peran Anda: Organization role
     • Apa pun — Tidak ada akses organisasi secara keseluruhan.
     • Anggota — Akses baca dasar ke organisasi.
     • Pengelola — Akses administratif penuh ke organisasi dan semua aplikasinya.
   • Akses aplikasi saja — Aktifkan Batasi kunci ini ke aplikasi yang dipilih. Setiap pengikat aplikasi tetap terkait dengan organisasi yang dimiliki oleh aplikasi tersebut; mode ini hanya mengabaikan peran RBAC organisasi secara keseluruhan.

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

   Mengambahkan izin global org.create Mengambahkan izin untuk organisasi org_admin atau org_super_admin Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped atau Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped

   • atau Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped Mengambahkan izin global. Kunci ini juga membutuhkan organisasi-skoped. Dalam dashboard, memilih Admin Untuk menampilkan aplikasinya. Pengikat aplikasi yang dipilih tetap terkait dengan organisasinya; filter ini tidak memberikan akses organisasi secara keseluruhan.
   • Klik ”+ Tambah Aplikasi”Pilih satu atau lebih aplikasi, kemudian tentukan peran untuk setiap aplikasi:
     • Pengguna Aplikasi — Akses baca-saja ke aplikasi.
     • Pengunggah Aplikasi — Dapat mengunggah bundle baru.
     • Pengembang Aplikasi — Dapat mengunggah bundle, mengelola perangkat, memicu build native, dan mengatur pengaturan saluran.
     • Pengelola Aplikasi — Akses penuh ke aplikasi.
     • Pratinjau Aplikasi — Tampilkan pratinjau siklus CI/CD: unggah bundle dan buat kanal pratinjau. Kanal ini menerima hak siklus yang otomatis dan terbatas pada kanal ini hanya untuk kunci ini.

6. Klik “Buat”.

7. Jika Anda telah memeriksa Buat kunci aman, sebuah modal akan menampilkan kunci teks biasa. Salin segera — kunci ini tidak dapat diperoleh setelah menutup modal.

Pakai kunci Pratinjau Aplikasi untuk alur kerja pratinjau

Menggunakan Penglihatan Aplikasi untuk CI yang membuat saluran pratinjau sementara, tidak publik, mengunggah dan mempromosikan paket, kemudian menghapus kedua saluran dan paket. Ini tidak memiliki akses ke siklus saluran default atau utama yang ada.

1. Buatlah kunci RBAC dan aktifkan Hanya batasi kunci ini pada aplikasi yang dipilih.
2. Di bawah Untuk menyaring aplikasi, pilih organisasi, pilih organisasi untuk menampilkan aplikasinya; setiap aplikasi yang dipilih tetap terkait dengan organisasinya.
3. Tambahkan hanya aplikasi atau aplikasi yang digunakan untuk pengiriman pratinjau.
4. Pilih Penglihatan Aplikasi untuk setiap aplikasi yang dipilih.
5. Membuat kunci yang aman, tentukan tanggal kedaluwarsa ketika perlu, dan simpan di manajer rahasia CI Anda.

Mode aplikasi yang dipilih ini mengabaikan peran organisasi yang meluas; itu tidak menghapus asosiasi organisasi. Setiap app_preview pengikat tetap terkait dengan aplikasi yang dipilih dan organisasi yang dimiliki aplikasi tersebut.

Berikan	Otorisasi dan batasan
app_preview pada aplikasi yang dipilih	app.read, app.read_bundles, app.upload_bundle, dan app.create_channel.
Autentikasi channel_preview context	When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundledan channel.delete untuk saluran itu saja.

app_preview menyimpan app.read, sehingga kunci tersebut dapat menampilkan metadata saluran yang dipilih di aplikasi yang diatur. perbatasan manajemen: tidak memberikan mutasi siklus hidup untuk saluran yang tidak dibuat oleh kunci tersebut. __CAPGO_KEEP_0__ juga merekam kunci App Preview yang mengunggah bundle. Kunci tersebut hanya dapat mengatur bundle sendiri di setiap saluran pratinjau yang dibuat dan dapat membersihkan pasangan tersebut bersamaan. Kunci tersebut tidak menerima ikatan saluran untuk saluran default atau utama yang sudah ada, saluran yang dibuat oleh kunci pratinjau lain, atau bundle milik kunci lain.

Capgo also records which App Preview key uploaded a bundle. The key can set only its own bundle on each preview channel it creates and can clean up that pair together. It does not receive a channel binding for an existing default or main channel, a channel created by another preview key, or another key’s bundle.

Jendela terminal

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

membuat saluran, mengunggah bundle, dan mempromosikannya dalam satu aliran. Perintah terakhir menggunakan jalur pembersihan atomik sempit: perintah tersebut hanya berhasil ketika kunci tersebut memiliki saluran pratinjau dan bundle yang terkait, tidak bersamaan. bundle upload --channel membuat saluran, mengunggah bundle, dan mempromosikannya dalam satu aliran. Perintah terakhir menggunakan jalur pembersihan atomik sempit: perintah tersebut hanya berhasil ketika kunci tersebut memiliki saluran pratinjau dan bundle yang terkait, tidak bersamaan. Pratinjau Aplikasi belum memiliki akses umum bundle.delete, sehingga tidak dapat menghapus paket sembarang.

Pertimbangan

Gunakan saluran non-umum baru. pr-<number> Tidak boleh melewatkan --default, --self-assign, opsi peluncuran, atau --delete-linked-bundle-on-upload ke dalam alur kerja ini. Sebuah Pratinjau Aplikasi tidak dapat mempromosikan, menghapus, atau mengubah saluran default utama yang sudah ada, saluran pratinjau kunci lainnya, atau paket kunci lainnya. Mengambil kembali atau mengakhiri ikatan aplikasi juga menghapus akses siklus efektif kunci.

Lihat Panduan Kontrol Akses untuk batasan penuh.

Bagaimana mengelola (mengedit) sebuah API kunci?

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

• Mengubah nama kunci Mengupdate.
• peran organisasi Mengaktifkan atau menonaktifkan.
• Mengubah kunci Mengizinkan pembuatan organisasi ketika kunci memiliki peran organisasi Admin.
• Tambahkan, hapus, atau ubah peran aplikasi.

Klik “Simpan Perubahan” ketika selesai.

Bagaimana cara mengregenerasi kunci API?

Untuk mengregenerasi nilai rahasia kunci API, klik ikon refresh Section titled “How to regenerate an __CAPGO_KEEP_0__ key?” Menghasilkan ulang) pada kunci mana pun di daftar.

Akan muncul dialog konfirmasi. Setelah mengonfirmasi:

• Untuk Kunci (terenkripsi) yang aman: Kunci teks biasa baru dihasilkan dan ditampilkan sekali dalam modal. Salinlah segera.
• Untuk Kunci teks 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 sampah ikon sampah Hapus (Delete) pada setiap kunci dalam daftar. Konfirmasi penghapusan dalam dialog.

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

Kunci Legacy

Jika Anda melihat kunci di dalam Kunci Legacy bagian (kunci tanpa penugasan peran), kunci tersebut menggunakan sistem izin mode lama (“read, upload, write, allKunci Legacy dapat diregenerasi dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan peran RBAC. Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci Legacy ketika memungkinkan.

Legacy keys can be regenerated and deleted from the list, but cannot be edited to add RBAC roles. We recommend creating new RBAC keys and deleting legacy keys when possible.

Jika Anda perlu mengelola kunci legasi secara langsung, Anda masih dapat mengaksesnya di console.capgo.app/dashboard/apikeysHalaman ini sudah tidak digunakan dan akan dihapus dalam pembaruan masa depan.

Lanjutkan dari Kunci API

Jika Anda menggunakan Kunci API untuk merencanakan dashboard dan operasi API, hubungkan dengan Tinjauan API untuk detail implementasi di Tinjauan API Pendahuluan untuk detail implementasi di Pendahuluan Kunci API untuk detail implementasi di Kunci API Perangkat untuk detail implementasi di Perangkat, dan Paket untuk detail implementasi di Paket.