Membuat kunci API
Buat API key dan kelola produk, webhook, IP whitelist, penggantian, serta status.
Halaman ini menjelaskan cara membuat dan mengelola kredensial API untuk Workspace saat ini melalui Console > Developers. Untuk integrasi kode dan autentikasi permintaan, lihat Autentikasi.
Sebelum memulai
- Periksa Workspace yang dipilih: API key milik Workspace tersebut, bukan milik pribadi pembuatnya.
- Aktifkan setidaknya satu produk: API key tidak dapat dibuat tanpa produk aktif. Hanya produk aktif yang dapat dipilih untuk otorisasi kunci.
- Miliki izin yang diperlukan: izin untuk melihat, membuat, dan mengelola API key ditentukan oleh peran yang ditetapkan dalam Workspace saat ini. Owner organisasi adalah identitas kepemilikan pada tingkat organisasi dan tidak digunakan untuk menentukan izin peran Workspace.
| Kredensial | Fungsi |
|---|---|
| API Key | Mengidentifikasi kunci yang digunakan untuk permintaan dan Workspace pemiliknya. |
| API Secret | Digunakan bersama API Key untuk autentikasi sesuai persyaratan produk. Simpan dengan aman. |
Buat API key
Isi informasi dasar
Pilih Create ApiKey. Isi APIKEY NAME sesuai aplikasi atau tujuan penggunaan; Description opsional. Pilih Continue.
Pilih produk
Pada Activate products, pilih produk aktif yang diperlukan kunci ini, lalu Continue.
Tinjau dan buat
Periksa nama dan produk. Webhook dan IP whitelist awalnya Not configured dan dapat ditambahkan pada detail. Pilih Generate ApiKey.
Otorisasi produk yang dipilih tidak memerlukan peninjauan dan dapat langsung diaktifkan. Periksa status kunci dan produk terkait sebelum mengirim trafik produksi.
Simpan kredensial
Salin API KEY dan API SECRET, atau pilih Download TXT, lalu simpan dengan aman di server. Centang I have copied and stored the secret safely, lalu pilih Continue to ApiKey detail.
Secret hanya ditampilkan sekali dan tidak dapat dipulihkan setelah ditutup. Jangan simpan di kode browser, repositori, log, atau tangkapan layar yang dibagikan.
Lihat dan kelola API key
Cari kunci dan lihat detailnya
Gunakan all, active, disabled, atau Search name or prefix untuk mencari kunci. Pilih ikon mata pada Actions untuk membuka detail. Pada Overview, periksa prefiks, status, pembuat, waktu pembuatan, dan produk terkait.
Tambahkan otorisasi produk
Pilih Add products, pilih produk yang sudah aktif dalam Workspace saat ini dan belum terkait dengan kunci ini, lalu Confirm. Produk berlabel Already added tidak dapat dipilih lagi. Aktivasi produk maupun otorisasi produk pada kunci tidak memerlukan peninjauan dan dapat langsung diaktifkan.
Penghapusan ikatan produk yang ada dan pengajuan ulang otorisasi untuk produk yang sudah ditambahkan tidak didukung. Pastikan produk dan tujuan sebelum menambahkannya.
Konfigurasikan webhook
Buka Webhooks → Add webhook.
- Product — Pilih produk. Konfigurasi berlaku per API key dan produk; produk yang sudah memiliki webhook disembunyikan saat menambahkan.
- Endpoint URL — Masukkan alamat callback HTTPS.
- Event types — Pilih peristiwa yang akan diterima. Opsi mengikuti produk.
- Signing secret — Aktifkan verifikasi callback jika diperlukan, lalu terapkan sesuai mekanisme dalam dokumentasi produk.
Pilih Add webhook untuk menyimpan.
Konfigurasikan IP whitelist
Buka IP Whitelist. Isi IP atau CIDR publik server pemanggil, tambahkan deskripsi jika perlu, lalu pilih Add. Gunakan ikon hapus untuk menghapus entri.
Periksa IP keluar aplikasi sebelum mengubah daftar agar pemanggil yang diperlukan tetap diizinkan.
Ganti kunci
Gunakan Replace Key jika Secret hilang, kredensial diduga bocor, atau Anda perlu merotasi kredensial secara berkala. Secret yang hilang tidak dapat dipulihkan; perbarui semua pemanggil dengan kredensial pengganti.
Jika kredensial diduga bocor, segera nonaktifkan kunci lama untuk mencegah penggunaan lebih lanjut. Pemanggil yang belum beralih dapat terganggu. Untuk rotasi rutin, uji kunci pengganti sebelum menonaktifkan kunci lama.
Buka Replace Key, isi New key name, lalu pilih Create replacement. Kunci baru menyalin produk terkait, webhook, dan IP whitelist. Simpan secret baru, perbarui kredensial aplikasi, dan uji kunci baru sebelum menonaktifkan kunci lama.
Kunci lama tidak kedaluwarsa otomatis. Nonaktifkan secara manual setelah semua pemanggil beralih ke penggantinya.
Nonaktifkan dan pulihkan
Nonaktifkan
Buka detail kunci, masuk ke Danger Zone, pilih Disable this ApiKey, lalu Confirm.
Pulihkan
Cari kunci nonaktif, pilih Restore, lalu Confirm. Periksa status sebelum melanjutkan permintaan.
Penonaktifan langsung memblokir panggilan API dengan kunci ini; riwayat dan konfigurasi tetap tersimpan. Antarmuka saat ini mendukung penonaktifan, bukan penghapusan kunci.
Langkah berikutnya: panggil API dengan kredensial Anda
Lihat Autentikasi untuk persyaratan kredensial dan header, lalu verifikasi satu permintaan terkontrol melalui panduan cepat produk terkait.
Terakhir diperbarui pada