API-sleutels
Op deze pagina
Met API-sleutels kan je eigen software, of elk systeem van derden dat BYOK (Bring Your Own Key) ondersteunt, de modellen gebruiken die Performance Hub publiceert. Sleutels beheer je onder Settings (tandwiel) → Service Access & API Keys. Je moet Organisation Administrator zijn om ze te beheren.
"Verstrek API keys zodat derde-partijsoftware en systemen die BYOK (Bring Your Own Key) ondersteunen, verbinding kunnen maken met modellen die door Performance Hub worden gepubliceerd."
Afbeelding 1: De lijst met API-sleutels: label, gemaskeerde sleutel, status, uitgaven en limieten, modellen, laatste gebruik en de acties per rij
De lijst met sleutels
| Kolom | Betekenis |
|---|---|
| Label | De optionele naam die je de sleutel hebt gegeven. |
| Key | De gemaskeerde sleutel (bijvoorbeeld phk_7Qm2…Xa9LkP); het volledige geheim wordt na het aanmaken nooit meer getoond. |
| Status | Active, Provisioning… (kort, terwijl een nieuwe sleutel wordt ingericht) of Disabled (ingetrokken; de rij wordt gedimd). |
| Spend / limits | De uitgaven over de hele looptijd en de voortgang ten opzichte van eventuele uitgavenlimieten op de sleutel. |
| Models | all, of het aantal modellen waartoe de sleutel is beperkt. |
| Last used | Wanneer de sleutel voor het laatst een aanvraag heeft gedaan. |
| Actions | Edit, Rotate, Revoke (of Re-activate), Delete. |
Als je Workflows gebruikt, toont een rij Workflows de tekst Managed service in plaats van een gemaskeerde sleutel. Als er helemaal geen sleutels zijn, toont de lijst "No API keys yet."
Een sleutel aanmaken
Klik op Create key. Het paneel Create API key wordt geopend:
Afbeelding 2: Het paneel Create API key: label, verbindingstype, uitgavenlimieten, snelheidslimieten, modelbeperking en afwijkende guardrails
| Instelling | Gedrag |
|---|---|
| Label (optional) | Een naam voor de sleutel, meestal het systeem waarvoor hij bedoeld is (bijvoorbeeld Hotel Concierge App, Clinic Intake Assistant of Booking Website). Sterk aanbevolen: aan de hand van labels wordt het gebruik toegewezen in Activity en 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." Wordt ingesteld bij het aanmaken van de sleutel en kan later niet worden gewijzigd. |
| 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).") en 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 en Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Kies uit de ingeschakelde modellen van de faciliteit. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Wanneer dit aanstaat, gebruikt deze sleutel een eigen selectie van guardrails in plaats van die van de faciliteit, ook als die selectie "geen" is. Zie Guardrails. |
Klik op Create key.
Het eenmalige geheim
De nieuwe sleutel wordt eenmalig getoond, in het dialoogvenster Copy your API key:
Afbeelding 3: De nieuwe sleutel wordt eenmalig getoond: kopieer hem voordat je het dialoogvenster sluit
"Dit is de enige keer dat de volledige sleutel wordt getoond. Bewaar deze op een veilige plek."
Kopieer de sleutel naar je geheimenbeheer voordat je op Done klikt. Nadat dit dialoogvenster is gesloten, wordt alleen nog de gemaskeerde vorm getoond. Ben je het geheim kwijt, gebruik dan Rotate om een nieuwe sleutel te krijgen.
Een sleutel bewerken
Klik op de rij van een sleutel (of op het potlood Edit) om het paneel Configure API key te openen, met dezelfde instellingen als bij het aanmaken (label, uitgavenlimieten, snelheidslimieten, modelbeperking, afwijkende guardrails):
Afbeelding 4: Het paneel Configure API key
Wijzigingen worden binnen enkele ogenblikken na het opslaan van kracht. Wanneer een sleutel limieten per dag/maand heeft, toont de rij het gebruik ten opzichte daarvan (Today, This month, Lifetime) en een badge Limit reached wanneer een limiet is bereikt.
Levenscyclus van een sleutel: roteren, intrekken, verwijderen
Elke actie heeft een bevestigingsvenster dat precies vermeldt wat er gaat gebeuren:
| Actie | Effect | Bevestigingstekst |
|---|---|---|
| Rotate | Geeft een nieuw geheim uit (eenmalig getoond) met dezelfde instellingen; het oude geheim werkt meteen niet meer. | "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 | Schakelt de sleutel meteen uit, omkeerbaar. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Herstelt een ingetrokken sleutel (hetzelfde geheim). | Geen; wordt meteen uitgevoerd. |
| Delete | Verwijdert de sleutel definitief. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Afbeelding 5: De bevestiging voor het verwijderen van een API-sleutel
Wat je gebruikt: roteer bij een vermoeden van een lek (de service behoudt zijn instellingen en geschiedenis; je werkt alleen het geheim bij); trek in om een systeem tijdelijk te pauzeren; verwijder alleen wanneer de integratie definitief verdwenen is.
Verbinding maken met een sleutel
De kaart Connecting to the API onder de lijst met sleutels toont de basis-URL en een voorbeeldaanvraag om te kopiëren en te plakken voor je omgeving. Zie Je applicatie verbinden voor de volledige snelstart met SDK-voorbeelden en foutafhandeling.