API Kunci

Kunci API menggunakan kontrol akses berdasarkan peran (RBAC). Kunci dapat memiliki peran organisasi luas, pengikat aplikasi, atau keduanya. Setiap pengikat aplikasi tetap terkait dengan organisasi yang menguasai aplikasi tersebut. Untuk hak istimewa yang paling sedikit, batasi kunci ke aplikasi yang dipilih daripada menetapkan peran organisasi luas.

Di mana kunci API diatur?

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

Halaman menampilkan dua bagian:

• Kunci RBAC – Kunci dengan peran yang ditetapkan (direkomendasikan). Kunci ini menggunakan sistem izin berdasarkan 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 kunci Nama:

   • (wajib) — Label deskriptif untuk kunci (misalnya, “Deploy CI/CD” atau “Monitoring Baca-Saja”). tombol
   • Membuat kunci yang aman (opsional) — Ketika centang, kunci di-hash di sisi server. Kunci teks biasa ditampilkan hanya sekali setelah pembuatan dan tidak dapat diperoleh lagi. Hanya sekali Setelah pembuatan dan tidak dapat diperoleh lagi.
   • Set 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: Peran Organisasi
     • Apa pun — Tidak ada akses organisasi secara keseluruhan.
     • Anggota — Akses baca dasar ke organisasi.
     • Pengelola — Akses administratif lengkap ke organisasi dan semua aplikasinya.
   • Akses aplikasi saja — Aktifkan Akses ini hanya untuk aplikasi tertentu. Setiap pengikat aplikasi tetap terkait dengan organisasi yang dimiliki aplikasi tersebut; mode ini hanya mengabaikan peran RBAC organisasi secara keseluruhan.

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

   Mengambahkan izin global ini. org.create Mengambahkan izin organisasi. org_admin atau org_super_admin Mengambahkan izin organisasi. Mengambahkan izin global ini. Menggunakan dashboard, memilih 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 ini.

   • Menggunakan dashboard, memilih Pengguna Mengambahkan izin global ini. Menggunakan dashboard, memilih pengguna Admin ini akan mengambahkan izin global ini. Ketika ini mengambahkan izin organisasi baru, __CAPGO_KEEP_0__ secara otomatis mengasignkan kunci ini sebagai Super Admin pada organisasi baru tersebut. Untuk memberikan akses aplikasi: Ketika "Mengurangi kunci ini pada aplikasi yang dipilih" diaktifkan, pilih organisasi di bawah "Organisasi untuk memfilter aplikasi". Untuk menampilkan aplikasinya. Pengikat aplikasi yang dipilih tetap terkait dengan organisasinya; filter ini tidak memberikan akses organisasi secara keseluruhan.
   • Klik ”+ Tambahkan 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 sebuah bundle dan buatkan saluran pratinjau. Saluran ini menerima hak siklus otomatis, hanya untuk saluran ini, dan hanya untuk kunci ini.

6. Klik “Buat”.

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

Pakai kunci Pratinjau Aplikasi untuk alur kerja pratinjau

Gunakan Tampilan Aplikasi untuk CI yang membuat saluran sementara, tidak publik, tampilan aplikasi, mengunggah dan mempromosikan paket, kemudian menghapus baik saluran maupun paket. Tidak memiliki akses ke siklus hidup saluran default atau utama yang sudah ada.

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

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

Berikan	Kewenangan dan batasan
app_preview pada aplikasi yang dipilih	app.read, app.read_bundles, app.upload_bundle, dan app.create_channel.
Autentikasi Otomatis 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 tersebut. Pengikatan otomatis anak adalah pengelolaan batasan: tidak memberikan mutasi siklus untuk saluran yang tidak dibuat oleh kunci tersebut.

Capgo juga merekam saluran mana yang menggunakan kunci App Preview untuk mengunggah bundle. Kunci tersebut hanya dapat mengatur bundle miliknya 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.

Untuk pekerjaan CI biasa, gunakan nama saluran unik per permintaan pull:

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

Untuk saluran baru, bundle upload --channel membuat saluran, mengunggah bundle, dan mempromosikannya dalam satu alur. Perintah terakhir menggunakan jalur pembersihan atomik yang sempit: perintah tersebut hanya berhasil jika kunci tersebut memiliki saluran pratinjau dan bundle yang terkait dan tidak dibagikan. Pratinjau Aplikasi belum memiliki umum bundle.delete, sehingga tidak dapat menghapus paket sembarangan.

Pertimbangan

Gunakan saluran baru yang tidak umum. pr-<number> Tidak lakukan pengiriman opsi peluncuran, atau --default, --self-assignke dalam alur kerja ini. Sebuah --delete-linked-bundle-on-upload Pratinjau Aplikasi tidak dapat mempromosikan, menghapus, atau mengubah saluran yang sudah ada/default/main, saluran lainnya dari pratinjau kunci, atau paket kunci lainnya. Mengambil kembali atau mengakhiri ikatan aplikasi juga menghapus akses efektif siklus kunci. Lihat

API Keys Referensi Pengendalian Akses untuk batasan penuh.

Bagaimana mengelola (mengedit) sebuah API kunci?

Klik ikon ikik gergaji (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 Mengizinkan pembuatan organisasi Mengizinkan pembuatan organisasi ketika kunci memiliki peran organisasi Admin.
• Tambahkan, hapus, atau ubah peran aplikasi.

Klik “Simpan Perubahan” Mengizinkan pembuatan organisasi ketika selesai.

Bagaimana cara menghasilkan ulang kunci API?

Untuk menghasilkan ulang nilai rahasia kunci API, klik ikon refresh Simpan Perubahan Menghasilkan ulang) pada kunci apa pun di daftar.

Akan muncul dialog konfirmasi. Setelah mengkonfirmasi:

• 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 sisi server.

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

Bagaimana cara menghapus kunci API?

Klik ikon sampah ikon sampah (Hapus) pada kunci mana pun di daftar. Konfirmasi penghapusan di dialog.

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

Kunci Legacy

Jika Anda melihat kunci di Bab Kunci Legacy Bagian (kunci tanpa penugasan peran), kunci-kunci ini menggunakan sistem izin berbasis mode yang lebih tua (read, upload, write, allKunci Legacy dapat diulang dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan peran RBAC. Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci Legacy ketika memungkinkan.

Kunci Legacy dapat diulang 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.app/dashboard/apikeysHalaman ini sudah tidak digunakan dan akan dihapus dalam pembaruan masa depan.

Lanjutkan dari API Keys

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