API-Schlüssel
Auf dieser Seite
Mit API-Schlüsseln kann Ihre eigene Software – oder jedes Drittsystem, das BYOK (Bring Your Own Key) unterstützt – die vom Performance Hub veröffentlichten Modelle nutzen. Schlüssel werden unter Einstellungen (Zahnrad) → Service Access & API Keys verwaltet. Zum Verwalten benötigen Sie die Rolle Organisation Administrator.
"Stellen Sie API-Schlüssel bereit, damit Software von Drittanbietern und Systeme, die BYOK (Bring Your Own Key) unterstützen, eine Verbindung zu von Performance Hub veröffentlichten Modellen herstellen können."
Abbildung 1: Die Liste der API-Schlüssel: Bezeichnung, maskierter Schlüssel, Status, Ausgaben und Limits, Modelle, letzte Nutzung und die Zeilenaktionen
Die Schlüsselliste
| Spalte | Bedeutung |
|---|---|
| Label | Der optionale Name, den Sie dem Schlüssel gegeben haben. |
| Key | Der maskierte Schlüssel (z. B. phk_7Qm2…Xa9LkP) – der vollständige Geheimschlüssel wird nach der Erstellung nie wieder angezeigt. |
| Status | Active, Provisioning… (kurzzeitig, während ein neuer Schlüssel eingerichtet wird) oder Disabled (widerrufen; die Zeile wird abgeblendet). |
| Spend / limits | Gesamtausgaben und Fortschritt in Bezug auf etwaige für den Schlüssel festgelegte Ausgabenlimits. |
| Models | all oder die Anzahl der Modelle, auf die der Schlüssel beschränkt ist. |
| Last used | Wann der Schlüssel zuletzt eine Anfrage gestellt hat. |
| Actions | Edit, Rotate, Revoke (bzw. Re-activate), Delete. |
Wenn Sie Workflows verwenden, zeigt eine Zeile Workflows anstelle eines maskierten Schlüssels Managed service. Gibt es überhaupt keine Schlüssel, zeigt die Liste "No API keys yet."
Einen Schlüssel erstellen
Klicken Sie auf Create key. Der Bereich Create API key wird geöffnet:
Abbildung 2: Der Bereich Create API key: Bezeichnung, Verbindungstyp, Ausgabenlimits, Ratenlimits, Modellbeschränkung und abweichende Guardrails
| Einstellung | Verhalten |
|---|---|
| Label (optional) | Ein Name für den Schlüssel, meist das System, für das er bestimmt ist (zum Beispiel Hotel Concierge App, Clinic Intake Assistant oder Booking Website). Dringend empfohlen – über Bezeichnungen wird die Nutzung in Activity und Logs zugeordnet. |
| 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." Wird beim Erstellen des Schlüssels festgelegt und kann später nicht geändert werden. |
| 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).") und 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 und Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Wählen Sie aus den für die Einrichtung aktivierten Modellen. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Wenn aktiviert, verwendet dieser Schlüssel statt der Auswahl der Einrichtung seine eigene Guardrail-Auswahl – einschließlich „keine“. Siehe Guardrails. |
Klicken Sie auf Create key.
Der einmalig angezeigte Geheimschlüssel
Der neue Schlüssel wird einmalig im Dialog Copy your API key angezeigt:
Abbildung 3: Der neue Schlüssel wird nur einmal angezeigt: Kopieren Sie ihn, bevor Sie den Dialog schließen
"Dies ist das einzige Mal, dass der vollständige Schlüssel angezeigt wird. Bewahren Sie ihn an einem sicheren Ort auf."
Kopieren Sie ihn in Ihren Secret Manager, bevor Sie auf Done klicken. Nachdem dieser Dialog geschlossen wurde, wird nur noch die maskierte Form angezeigt. Wenn Sie den Geheimschlüssel verlieren, rotieren Sie den Schlüssel mit Rotate, um einen neuen zu erhalten.
Einen Schlüssel bearbeiten
Klicken Sie auf die Zeile eines Schlüssels (oder auf das Stiftsymbol Edit), um den Bereich Configure API key zu öffnen – mit denselben Einstellungen wie beim Erstellen (Bezeichnung, Ausgabenlimits, Ratenlimits, Modellbeschränkung, abweichende Guardrails):
Abbildung 4: Der Bereich Configure API key
Änderungen werden wenige Augenblicke nach dem Speichern wirksam. Hat ein Schlüssel Tages- oder Monatslimits, zeigt seine Zeile die Nutzung im Verhältnis dazu (Today, This month, Lifetime) sowie ein Limit reached-Badge, wenn ein Limit erreicht ist.
Lebenszyklus eines Schlüssels: Rotieren, Widerrufen, Löschen
Jede Aktion hat einen Bestätigungsdialog, der genau beschreibt, was passieren wird:
| Aktion | Wirkung | Bestätigungstext |
|---|---|---|
| Rotate | Stellt einen neuen Geheimschlüssel (einmalig angezeigt) mit denselben Einstellungen aus; der alte Geheimschlüssel funktioniert sofort nicht mehr. | "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 | Deaktiviert den Schlüssel sofort und umkehrbar. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Stellt einen widerrufenen Schlüssel wieder her (derselbe Geheimschlüssel). | Keiner – wird sofort ausgeführt. |
| Delete | Entfernt den Schlüssel dauerhaft. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Abbildung 5: Die Bestätigung zum Löschen eines API-Schlüssels
Was Sie verwenden sollten: Rotieren Sie bei Verdacht auf ein Datenleck (der Dienst behält seine Einstellungen und seinen Verlauf – aktualisieren Sie nur den Geheimschlüssel); widerrufen Sie, um ein System vorübergehend zu pausieren; löschen Sie nur, wenn die Integration endgültig entfällt.
Mit einem Schlüssel verbinden
Die Karte Connecting to the API unter der Schlüsselliste zeigt die Basis-URL und eine Beispielanfrage zum Kopieren und Einfügen für Ihre Umgebung. Den vollständigen Schnellstart mit SDK-Beispielen und Fehlerbehandlung finden Sie unter Ihre Anwendung verbinden.