API anahtarları
Bu sayfada
API anahtarları, kendi yazılımınızın veya BYOK (Bring Your Own Key, kendi anahtarını getir) destekleyen herhangi bir üçüncü taraf sistemin Performance Hub tarafından yayımlanan modelleri kullanmasını sağlar. Anahtarlar Settings (dişli) → Service Access & API Keys altında yönetilir. Bunları yönetmek için Organisation Administrator olmanız gerekir.
"BYOK (Kendi Anahtarını Getir) destekleyen üçüncü taraf yazılımların ve sistemlerin Performance Hub tarafından yayınlanan modellere bağlanabilmesi için API anahtarları sağlayın."
Şekil 1: API anahtarları listesi: etiket, maskelenmiş anahtar, durum, harcama ve sınırlar, modeller, son kullanım ve satır eylemleri
Anahtar listesi
| Sütun | Anlamı |
|---|---|
| Label | Anahtara verdiğiniz isteğe bağlı ad. |
| Key | Maskelenmiş anahtar (ör. phk_7Qm2…Xa9LkP); tam gizli anahtar oluşturulduktan sonra bir daha hiçbir zaman gösterilmez. |
| Status | Active, Provisioning… (yeni bir anahtar ayarlanırken kısa bir süre için) veya Disabled (iptal edilmiş; satır soluk gösterilir). |
| Spend / limits | Kullanım süresi boyunca harcama ve anahtarda belirlenmiş harcama sınırlarına göre ilerleme. |
| Models | all veya anahtarın kısıtlandığı model sayısı. |
| Last used | Anahtarın en son istek yaptığı zaman. |
| Actions | Edit, Rotate, Revoke (veya Re-activate), Delete. |
Workflows kullanıyorsanız bir Workflows satırı, maskelenmiş anahtar yerine Managed service gösterir. Hiç anahtar yoksa liste "No API keys yet." gösterir.
Anahtar oluşturma
Create key düğmesine tıklayın. Create API key çekmecesi açılır:
Şekil 2: Create API key çekmecesi: etiket, bağlantı türü, harcama sınırları, hız sınırları, model kısıtlaması ve guardrail geçersiz kılma
| Ayar | Davranış |
|---|---|
| Label (optional) | Anahtar için bir ad; genellikle anahtarın kullanılacağı sistem (örneğin Hotel Concierge App, Clinic Intake Assistant veya Booking Website). Kesinlikle önerilir: Activity ve Logs bölümlerinde kullanım etiketlere göre ilişkilendirilir. |
| 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." Anahtar oluşturulurken ayarlanır; daha sonra değiştirilemez. |
| 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).") ve 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 ve Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Tesisin etkin modelleri arasından seçim yapın. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Açık olduğunda bu anahtar, tesisin seçimi yerine kendi guardrail seçimini ("none" dahil) kullanır. Bkz. Guardrails. |
Create key düğmesine tıklayın.
Tek seferlik gizli anahtar
Yeni anahtar Copy your API key iletişim kutusunda yalnızca bir kez gösterilir:
Şekil 3: Yeni anahtar yalnızca bir kez gösterilir: iletişim kutusunu kapatmadan önce kopyalayın
"Tam anahtar yalnızca bu sefer gösterilir. Güvenli bir yerde saklayın."
Done düğmesine tıklamadan önce anahtarı gizli bilgi yöneticinize kopyalayın. Bu iletişim kutusu kapandıktan sonra yalnızca maskelenmiş biçim gösterilir. Gizli anahtarı kaybederseniz yenisini almak için anahtarı Rotate ile döndürün.
Anahtarı düzenleme
Configure API key çekmecesini açmak için bir anahtarın satırına (veya Edit kalem simgesine) tıklayın; oluşturma sırasındakiyle aynı ayarlar bulunur (etiket, harcama sınırları, hız sınırları, model kısıtlaması, guardrail geçersiz kılma):
Şekil 4: Configure API key çekmecesi
Değişiklikler kaydettikten birkaç saniye sonra geçerli olur. Bir anahtarın günlük/aylık sınırları varsa satırında bunlara göre kullanım (Today, This month, Lifetime) ve bir sınıra ulaşıldığında Limit reached rozeti gösterilir.
Anahtar yaşam döngüsü: döndürme, iptal etme, silme
Her eylemin, tam olarak ne olacağını belirten bir onay iletişim kutusu vardır:
| Eylem | Etkisi | Onay metni |
|---|---|---|
| Rotate | Aynı ayarlarla yeni bir gizli anahtar oluşturur (bir kez gösterilir); eski gizli anahtar hemen çalışmayı durdurur. | "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 | Anahtarı hemen ve geri alınabilir şekilde devre dışı bırakır. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | İptal edilmiş bir anahtarı geri yükler (aynı gizli anahtar). | Yok; hemen çalışır. |
| Delete | Anahtarı kalıcı olarak kaldırır. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Şekil 5: Delete API key onayı
Hangisi kullanılmalı: sızıntı şüphesinde döndürün (hizmet ayarlarını ve geçmişini korur; yalnızca gizli anahtarı güncellersiniz); bir sistemi geçici olarak duraklatmak için iptal edin; yalnızca entegrasyon tamamen kaldırıldığında silin.
Anahtarla bağlanma
Anahtar listesinin altındaki Connecting to the API kartı, ortamınız için temel URL'yi ve kopyalayıp yapıştırabileceğiniz örnek bir isteği gösterir. SDK örnekleri ve hata işlemeyle birlikte tam hızlı başlangıç için bkz. Uygulamanızı bağlama.