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 hak istimewa yang paling sedikit, 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.

Berikut 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”). button di atas tabel kunci RBAC.
   • Membuat kunci yang aman (opsional) — Ketika dicentang, kunci di-hash di sisi server. Kunci teks biasa hanya ditampilkan sekali saja setelah pembuatan dan tidak dapat diperoleh kembali. Hanya sekali Setelah pembuatan dan tidak dapat diperoleh kembali.
   • 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 organisasi. Peran yang tersedia tergantung pada tingkat peran Anda: Peran Organisasi
     • Tidak Ada — Tidak ada akses organisasi-wide.
     • Anggota — Akses baca dasar ke organisasi.
     • Admin — Akses administratif penuh ke organisasi dan semua aplikasinya.
   • Akses aplikasi saja — Aktifkan Batasi kunci ini ke aplikasi yang dipilih. Setiap pengikatan aplikasi tetap terkait dengan organisasi yang dimiliki aplikasi tersebut; mode ini hanya mengabaikan peran RBAC organisasi-wide.

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

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

5. Mengubah menghasilkan

   • Mengubah menghasilkan Mengubah menghasilkan Mengubah menghasilkan Mengubah menghasilkan Membuka aplikasinya. Ikatan 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:
     • Pembaca 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 menampilkan kunci teks biasa. Salin segera — tidak dapat diambil kembali setelah menutup modal.

Pakai kunci Pratinjau Aplikasi untuk alur kerja pratinjau

Menggunakan Tampilan Aplikasi untuk CI yang membuat saluran pratinjau sementara, tidak publik, mengunggah dan mempromosikan paket, kemudian menghapus kedua saluran dan paket. Saluran ini tidak memiliki akses ke saluran default atau utama yang sudah ada.

1. Buat kunci RBAC dan aktifkan Pasang batasan ini pada aplikasi yang dipilih.
2. Di bawah Organisasi untuk memfilter aplikasi, 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 Tampilan Aplikasi untuk setiap aplikasi yang dipilih.
5. Membuat kunci yang aman, atur 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 aplikasinya yang dipilih dan organisasi yang dimiliki aplikasi tersebut.

Berikan	Kewenangan dan batas
app_preview pada aplikasinya yang dipilih	app.read, app.read_bundles, app.upload_bundle, dan app.create_channel.
Autentikasi channel_preview context: Halaman/area: Halaman pemasaran solusi Capgo. Peran: Label UI singkat atau item navigasi. Dilihat di: halaman solusi/pr-preview.astro. Pesan kunci `solutions_pr_step1_time` (Solutions Pr Step1 Time).	pengikat kunci ini membuat saluran, Capgo secara otomatis memberikan kunci 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 anak otomatis adalah pengelolaan batas: tidak memberikan mutasi siklus hidup untuk saluran yang tidak dibuat oleh kunci tersebut.

Capgo juga merekam saluran mana yang kunci App Preview unggah 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 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 aliran. Perintah terakhir menggunakan jalur pembersihan atomik sempit: perintah tersebut hanya berhasil ketika kunci tersebut memiliki saluran pratinjau dan bundle terkait yang tidak dibagikan. Pratinjau Aplikasi belum memiliki umum bundle.delete, sehingga tidak dapat menghapus paket sembarang.

Pertimbangan

Gunakan saluran baru yang tidak umum. pr-<number> Tidak lakukan pengiriman --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/main yang ada, saluran lainnya dari pratinjau kunci, atau paket kunci lainnya. Mengambil kembali atau mengakhiri ikatan aplikasi juga menghilangkan akses siklus efektif kunci.

Lihat Referensi Pengendalian Akses untuk batasan penuh.

Bagaimana mengelola (mengedit) sebuah API kunci?

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

• Ganti nama kunci Update peran organisasi.
• Aktifkan atau nonaktifkan Ubah kunci.
• nama Mengizinkan pembuatan organisasi ketika kunci memiliki peran organisasi Admin.
• Tambahkan, hapus, atau ubah peran aplikasi.

Klik “Simpan Perubahan” ketika selesai.

Bagaimana cara mengulangi kunci API?

Untuk mengulangi nilai rahasia kunci API, klik ikon refresh refresh icon Menghasilkan ulang) pada kunci mana 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 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 setiap kunci dalam daftar. Konfirmasi penghapusan dalam dialog.

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

Kunci Legacy

Jika Anda melihat kunci dalam Bab Kunci Legacy bagian (kunci tanpa penugasan peran), kunci tersebut menggunakan sistem izin berbasis mode yang lebih 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.

Kunci 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.

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 Kunci API

Jika Anda menggunakan Kunci API untuk merencanakan dashboard dan operasi API, hubungkan 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.