Kunci API

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 dikelola?

Navigasikan ke Pengaturan > Organisasi > Kunci API di console.capgo.app/pengaturan/organisasi/api-kunci.

Halaman ini menampilkan dua bagian:

• Kunci RBAC Kunci dengan peran yang ditugaskan (direkomendasikan). Kunci ini menggunakan sistem izin berbasis peran baru.
• Kunci Legacy Kunci lama yang menggunakan sistem mode sederhana (read, upload, write, all) tanpa penugasan peran.

Bagaimana cara membuat kunci API baru?

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

2. Isi informasi kunci Informasi kunci:

   • Nama Nama kunci (wajib) — Label deskriptif untuk kunci (misalnya, “Deploy CI/CD” atau “Monitoring Read-Only”).
   • Buat kunci aman Opsional) — Ketika dicentang, kunci di-hash di sisi server. Kunci teks biasa hanya ditampilkan Saja sekali Setelah pembuatan dan tidak dapat diperoleh kembali.
   • Atur Tanggal Kadaluarsa Opsional — Pilih tanggal setelah mana kunci tidak berfungsi lagi. Beberapa organisasi mewajibkan pengaturan tanggal kedaluwarsa melalui kebijakan.

3. Pilih ruang lingkup kunci:

   • Akses organisasi secara keseluruhan — Pilih sebuah Akses organisasi peran untuk menentukan izin dasar di seluruh organisasi. Peran yang tersedia bergantung pada tingkat peran Anda:
     • None — Tidak ada akses organisasi secara keseluruhan.
     • Anggota — Akses baca dasar ke organisasi.
     • Pengelola — Akses administratif penuh ke organisasi dan semua aplikasinya.
   • Akses aplikasi hanya — Aktifkan Batasi kunci ini pada aplikasi yang dipilihSetiap pengikatan aplikasi tetap terkait dengan organisasi yang mengelola aplikasi tersebut; mode ini hanya mengabaikan peran RBAC organisasi.

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

   Ini menambahkan kunci global org.create izin akses. Kunci tersebut juga memerlukan organisasi-skoped org_admin or org_super_admin binding. Pada dashboard, memilih Admin atau org_admin Kunci pengikat. Ketika kunci ini membuat organisasi baru, Capgo secara otomatis menetapkan kunci sebagai Admin Utama pada organisasi baru tersebut.

5. Untuk memberikan akses aplikasi:

   • When Mengatur batasan ini ke aplikasi yang dipilih aktif, 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 Pembaca — Akses baca-saja ke aplikasi.
     • Aplikasi Pengunggah — Dapat mengunggah bundle baru.
     • Developer Aplikasi — Dapat mengunggah bundle, mengelola perangkat, memicu bangun native, dan mengatur pengaturan saluran.
     • Admin Aplikasi — Akses penuh ke aplikasi.
     • App Preview — Tampilkan siklus CI/CD: unggah bundle dan buat saluran penglihatan. Saluran ini menerima hak siklus otomatis, hanya untuk saluran ini.

6. Klik “Buat”.

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

Pakai kunci App Preview untuk alur kerja preview.

Pakai App Preview untuk CI yang membuat saluran sementara, tidak publik, untuk melihat preview, mengunggah dan mempromosikan bundle, kemudian menghapus saluran dan bundle. 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 aplikasiPilih organisasi untuk menampilkan aplikasinya; setiap aplikasi yang dipilih tetap terkait dengan organisasinya.
3. Add only the app or apps used for preview deployments.
4. Pilih Aplikasi Pra-Tayang untuk setiap aplikasi yang dipilih.
5. Buatlah kunci yang aman, tetapkan tanggal kedaluwarsa ketika perlu, dan simpanlah di pengelola rahasia CI Anda.

Mode aplikasi yang dipilih hanya ini mengabaikan peran organisasi secara keseluruhan; itu tidak menghapus asosiasi organisasi. Setiap app_preview keterikatan tetap terbatas pada aplikasi yang dipilih dan organisasi yang dimiliki aplikasi tersebut.

Izinkan	Permissions and boundary
app_preview pada aplikasi yang dipilih	app.read, app.read_bundles, app.upload_bundledan app.create_channel.
Otomatis channel_preview pengikat	Ketika kunci ini membuat sebuah saluran, Capgo secara otomatis memberikan kunci channel.read, channel.promote_bundledan channel.delete untuk saluran tersebut saja.

app_preview menyimpan app.read, sehingga kunci dapat menelusuri metadata saluran di aplikasi yang dipilih. Pengikat anak otomatis adalah sebuah pengelolaan batas: tidak memberikan mutasi siklus untuk saluran yang kunci tidak buat.

Capgo juga merekam kunci App Preview mana yang mengunggah sebuah paket. Kunci dapat menetapkan hanya paketnya sendiri pada setiap saluran pratinjau yang dibuat dan dapat membersihkan pasangan tersebut bersamaan. Kunci tidak menerima pengikat saluran untuk saluran default atau utama yang sudah ada, saluran yang dibuat oleh kunci pratinjau lain, atau paket 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 pemulihan atomik sempit: perintah ini hanya berhasil ketika kunci memiliki saluran pratinjau dan bundle terkait yang tidak dibagikan. App Preview masih tidak memiliki fitur umum bundle.deletesehingga tidak dapat menghapus bundle sembarang.

Peringatan

Gunakan saluran baru yang tidak umum. pr-<number> Jangan melewatkan --default, --self-assignopsi peluncuran, atau --delete-linked-bundle-on-upload ke workflow ini. App Preview Kunci ini tidak dapat mempromosikan, menghapus, atau mengubah saluran utama/default atau saluran lainnya dari kunci lainnya atau paket kunci lainnya. Mengambil kunci aplikasi juga menghapus akses siklus efektif kunci.

Lihatlah Bagaimana mengelola (mengedit) kunci __CAPGO_KEEP_0__? Bagian berjudul “Bagaimana mengelola (mengedit) kunci __CAPGO_KEEP_0__?”

Bagaimana cara mengelola (mengedit) sebuah kunci API?

Klik tombol Mengubah kunci ini Pengelolaan dapat dilakukan pada setiap kunci RBAC di daftar ini. Ini membuka halaman detail kunci di mana Anda dapat:

• Mengubah kunci di daftar ini nama.
• Perbarui peran organisasi.
• Mengaktifkan atau menonaktifkan Memungkinkan pembuatan organisasi ketika kunci memiliki peran organisasi Admin.
• Tambah, hapus, atau ubah peran aplikasi.

Klik “Simpan Perubahan” ketika selesai.

Cara untuk menghasilkan kembali API kunci?

Untuk menghasilkan kembali nilai rahasia dari API kunci, klik ikon refresh ikon refresh (Regenerate) pada kunci mana pun di daftar.

Dialog konfirmasi akan muncul. Setelah mengkonfirmasi:

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

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

Cara menghapus kunci API?

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

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

Kunci Legacy

Jika Anda melihat kunci di Kunci Warisan bagian (kunci tanpa penugasan peran), ini menggunakan sistem izin berbasis mode yang lebih tua (read, upload, write, allMereka masih berfungsi, tetapi tidak mendapatkan manfaat dari hak akses RBAC yang halus.

Kunci warisan dapat diregenerasi dan dihapus dari daftar, tetapi tidak dapat diedit untuk menambahkan peran RBAC. Kami merekomendasikan membuat kunci RBAC baru dan menghapus kunci warisan ketika memungkinkan.

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

Judul bagian “Lanjutkan dari Kunci API”

__CAPGO_KEEP_0__ Kunci Kunci API Untuk merencanakan dashboard dan operasi API, hubungkannya dengan API Panduan Umum untuk detail implementasi di API Panduan Umum Pendahuluan untuk detail implementasi di Pendahuluan API Kunci untuk detail implementasi di API Kunci Perangkat untuk detail implementasi di Perangkat. Bundles untuk detail implementasi di Paket.