Kunci API
Di halaman ini
Kunci API memungkinkan perangkat lunak Anda sendiri — atau sistem pihak ketiga mana pun yang mendukung BYOK (Bring Your Own Key) — menggunakan model yang diterbitkan oleh Performance Hub. Kunci dikelola di Settings (roda gigi) → Service Access & API Keys. Anda harus menjadi Organisation Administrator untuk mengelolanya.
"Sediakan kunci API agar perangkat lunak dan sistem pihak ketiga yang mendukung BYOK (Bring Your Own Key) dapat terhubung ke model yang dipublikasikan oleh Performance Hub."
Gambar 1: Daftar kunci API: label, kunci yang disamarkan, status, pengeluaran dan batas, model, waktu terakhir digunakan, serta tindakan baris
Daftar kunci
| Kolom | Arti |
|---|---|
| Label | Nama opsional yang Anda berikan untuk kunci. |
| Key | Kunci yang disamarkan (misalnya phk_7Qm2…Xa9LkP) — rahasia lengkapnya tidak pernah ditampilkan lagi setelah dibuat. |
| Status | Active, Provisioning… (sebentar, saat kunci baru sedang disiapkan), atau Disabled (dicabut; baris tampak redup). |
| Spend / limits | Pengeluaran seumur hidup, dan progres terhadap batas pengeluaran yang ditetapkan pada kunci. |
| Models | all, atau jumlah model yang dibatasi untuk kunci tersebut. |
| Last used | Kapan kunci terakhir kali melakukan permintaan. |
| Actions | Edit, Rotate, Revoke (atau Re-activate), Delete. |
Jika Anda menggunakan Workflows, baris Workflows menampilkan Managed service sebagai pengganti kunci yang disamarkan. Jika tidak ada kunci sama sekali, daftar menampilkan "No API keys yet."
Membuat kunci
Klik Create key. Laci Create API key akan terbuka:
Gambar 2: Laci Create API key: label, jenis koneksi, batas pengeluaran, batas laju, pembatasan model, dan penggantian guardrail
| Pengaturan | Perilaku |
|---|---|
| Label (optional) | Nama untuk kunci, biasanya sistem yang menggunakannya (misalnya Hotel Concierge App, Clinic Intake Assistant, atau Booking Website). Sangat disarankan — label adalah cara penggunaan diatribusikan di Activity dan Logs. |
| Connection type | API key — "Generic API keys remain in the API Keys list." External agent — "External agents appear under Connected Services and use this key to authenticate." Ditetapkan saat kunci dibuat; tidak dapat diubah setelahnya. |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." — Daily limit ("Resets at the start of each day (facility timezone)."), Monthly limit ("Resets on the 1st of each month (facility timezone)."), dan Lifetime cap ("Total spend over the lifetime of this key. Never resets."). |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." — Requests / min dan Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Pilih dari model yang diaktifkan untuk fasilitas. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Jika aktif, kunci ini menggunakan pilihan guardrail-nya sendiri, bukan milik fasilitas — termasuk "none". Lihat Guardrails. |
Klik Create key.
Rahasia satu kali
Kunci baru ditampilkan satu kali, di dialog Copy your API key:
Gambar 3: Kunci baru ditampilkan satu kali: salin sebelum Anda menutup dialog
"Ini adalah satu-satunya saat kunci lengkap ditampilkan. Simpan di tempat yang aman."
Salin ke pengelola rahasia Anda sebelum mengklik Done. Setelah dialog ini ditutup, hanya bentuk yang disamarkan yang akan ditampilkan. Jika Anda kehilangan rahasianya, lakukan Rotate pada kunci untuk mendapatkan yang baru.
Mengedit kunci
Klik baris kunci (atau pensil Edit-nya) untuk membuka laci Configure API key — pengaturan yang sama seperti saat pembuatan (label, batas pengeluaran, batas laju, pembatasan model, penggantian guardrail):
Gambar 4: Laci Configure API key
Perubahan berlaku dalam beberapa saat setelah disimpan. Jika kunci memiliki batas harian/bulanan, barisnya menampilkan penggunaan terhadap batas tersebut (Today, This month, Lifetime) dan lencana Limit reached saat salah satu batas tercapai.
Siklus hidup kunci: rotasi, pencabutan, penghapusan
Setiap tindakan memiliki dialog konfirmasi yang menyebutkan dengan tepat apa yang akan terjadi:
| Tindakan | Efek | Teks konfirmasi |
|---|---|---|
| Rotate | Menerbitkan rahasia baru (ditampilkan satu kali) dengan pengaturan yang sama; rahasia lama langsung berhenti berfungsi. | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | Menonaktifkan kunci secara langsung, dan dapat dibatalkan. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Memulihkan kunci yang dicabut (rahasia yang sama). | Tidak ada — langsung dijalankan. |
| Delete | Menghapus kunci secara permanen. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Gambar 5: Konfirmasi Delete API key
Mana yang digunakan: lakukan rotasi jika dicurigai terjadi kebocoran (layanan tetap mempertahankan pengaturan dan riwayatnya — cukup perbarui rahasianya); cabut untuk menjeda sistem sementara; hapus hanya jika integrasi sudah tidak digunakan lagi untuk selamanya.
Menghubungkan dengan kunci
Kartu Connecting to the API di bawah daftar kunci menampilkan URL dasar dan contoh permintaan siap salin-tempel untuk lingkungan Anda. Lihat Menghubungkan aplikasi Anda untuk panduan cepat lengkap dengan contoh SDK dan penanganan kesalahan.