Kunci API
Pada halaman ini
Kunci API membolehkan perisian anda sendiri — atau mana-mana sistem pihak ketiga yang menyokong BYOK (Bring Your Own Key) — menggunakan model yang diterbitkan oleh Performance Hub. Kunci diuruskan di bawah Tetapan (ikon gear) → Service Access & API Keys. Anda perlu menjadi Organisation Administrator untuk mengurusnya.
"Sediakan kunci API supaya perisian dan sistem pihak ketiga yang menyokong BYOK (Bring Your Own Key) boleh menyambung kepada model yang diterbitkan oleh Performance Hub."
Rajah 1: Senarai kunci API: label, kunci bertopeng, status, perbelanjaan dan had, model, penggunaan terakhir serta tindakan baris
Senarai kunci
| Lajur | Maksud |
|---|---|
| Label | Nama pilihan yang anda berikan kepada kunci. |
| Key | Kunci bertopeng (cth. phk_7Qm2…Xa9LkP) — rahsia penuh tidak akan ditunjukkan lagi selepas penciptaan. |
| Status | Active, Provisioning… (seketika, semasa kunci baharu disediakan), atau Disabled (dibatalkan; baris menjadi malap). |
| Spend / limits | Perbelanjaan seumur hayat, dan kemajuan ke arah sebarang had perbelanjaan yang ditetapkan pada kunci. |
| Models | all, atau bilangan model yang dihadkan untuk kunci tersebut. |
| Last used | Bila kunci terakhir membuat permintaan. |
| Actions | Edit, Rotate, Revoke (atau Re-activate), Delete. |
Jika anda menggunakan Workflows, baris Workflows menunjukkan Managed service sebagai ganti kunci bertopeng. Jika tiada kunci langsung, senarai menunjukkan "No API keys yet."
Mencipta kunci
Klik Create key. Laci Create API key akan dibuka:
Rajah 2: Laci Create API key: label, jenis sambungan, had perbelanjaan, had kadar, sekatan model dan penggantian pagar keselamatan
| Tetapan | Tingkah laku |
|---|---|
| Label (optional) | Nama untuk kunci, biasanya sistem yang menggunakannya (contohnya Hotel Concierge App, Clinic Intake Assistant atau Booking Website). Sangat disyorkan — label ialah cara penggunaan diatribusikan dalam 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 semasa kunci dicipta; ia tidak boleh diubah kemudian. |
| 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 daripada model yang didayakan untuk kemudahan. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Apabila dihidupkan, kunci ini menggunakan pilihan pagar keselamatannya sendiri dan bukannya pilihan kemudahan — termasuk "none". Lihat Pagar keselamatan. |
Klik Create key.
Rahsia sekali sahaja
Kunci baharu ditunjukkan sekali sahaja, dalam dialog Copy your API key:
Rajah 3: Kunci baharu ditunjukkan sekali sahaja: salin sebelum anda menutup dialog
"Ini adalah satu-satunya masa kunci penuh dipaparkan. Simpan di tempat yang selamat."
Salin kunci ke dalam pengurus rahsia anda sebelum mengklik Done. Selepas dialog ini ditutup, hanya bentuk bertopeng yang akan dipaparkan. Jika anda kehilangan rahsia, gunakan Rotate pada kunci untuk mendapatkan yang baharu.
Mengedit kunci
Klik baris kunci (atau ikon pensel Edit) untuk membuka laci Configure API key — tetapan yang sama seperti semasa penciptaan (label, had perbelanjaan, had kadar, sekatan model, penggantian pagar keselamatan):
Rajah 4: Laci Configure API key
Perubahan berkuat kuasa dalam beberapa saat selepas disimpan. Apabila kunci mempunyai had harian/bulanan, barisnya menunjukkan penggunaan berbanding had tersebut (Today, This month, Lifetime) dan lencana Limit reached apabila salah satunya dicapai.
Kitaran hayat kunci: putar, batal, padam
Setiap tindakan mempunyai dialog pengesahan yang menyatakan dengan tepat perkara yang akan berlaku:
| Tindakan | Kesan | Teks pengesahan |
|---|---|---|
| Rotate | Mengeluarkan rahsia baharu (ditunjukkan sekali) dengan tetapan yang sama; rahsia lama berhenti berfungsi serta-merta. | "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 | Menyahdayakan kunci serta-merta, secara boleh balik. | "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 dibatalkan (rahsia yang sama). | Tiada — dijalankan serta-merta. |
| Delete | Mengalih keluar kunci secara kekal. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Rajah 5: Pengesahan Delete API key
Yang mana patut digunakan: putar jika disyaki berlaku kebocoran (perkhidmatan mengekalkan tetapan dan sejarahnya — hanya kemas kini rahsia); batal untuk menjeda sistem buat sementara waktu; padam hanya apabila integrasi tidak lagi digunakan secara kekal.
Bersambung dengan kunci
Kad Connecting to the API di bawah senarai kunci menunjukkan URL asas dan contoh permintaan sedia salin-tampal untuk persekitaran anda. Lihat Menyambungkan aplikasi anda untuk panduan mula pantas yang lengkap dengan contoh SDK dan pengendalian ralat.