Clés API
Sur cette page
Les clés API permettent à vos propres logiciels, ou à tout système tiers prenant en charge le BYOK (Bring Your Own Key), d'utiliser les modèles publiés par Performance Hub. Les clés se gèrent sous Settings (roue dentée) → Service Access & API Keys. Vous devez être Organisation Administrator pour les gérer.
"Provisionnez des clés API pour permettre aux logiciels et systèmes tiers prenant en charge le BYOK (Bring Your Own Key) de se connecter aux models publiés par Performance Hub."'
Figure 1 : La liste des clés API : libellé, clé masquée, état, dépenses et limites, modèles, dernière utilisation et actions de ligne
La liste des clés
| Colonne | Signification |
|---|---|
| Label | Le nom facultatif que vous avez donné à la clé. |
| Key | La clé masquée (par exemple phk_7Qm2…Xa9LkP) : le secret complet n'est plus jamais affiché après la création. |
| Status | Active, Provisioning… (brièvement, pendant la configuration d'une nouvelle clé) ou Disabled (révoquée ; la ligne est grisée). |
| Spend / limits | Les dépenses à vie et leur progression par rapport aux éventuelles limites de dépenses définies sur la clé. |
| Models | all, ou le nombre de modèles auxquels la clé est limitée. |
| Last used | La date de la dernière requête effectuée avec la clé. |
| Actions | Edit, Rotate, Revoke (ou Re-activate), Delete. |
Si vous utilisez des Workflows, une ligne Workflows affiche Managed service à la place d'une clé masquée. En l'absence de toute clé, la liste affiche "No API keys yet."
Créer une clé
Cliquez sur Create key. Le panneau Create API key s'ouvre :
Figure 2 : Le panneau Create API key : libellé, type de connexion, limites de dépenses, limites de débit, restriction de modèles et remplacement des guardrails
| Paramètre | Comportement |
|---|---|
| Label (optional) | Un nom pour la clé, généralement celui du système auquel elle est destinée (par exemple Hotel Concierge App, Clinic Intake Assistant ou Booking Website). Fortement recommandé : les libellés servent à attribuer l'utilisation dans Activity et 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." Défini à la création de la clé ; il ne peut pas être modifié ensuite. |
| 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).") et 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 et Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Choisissez parmi les modèles activés pour l'installation. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Lorsque cette option est activée, la clé utilise sa propre sélection de guardrails au lieu de celle de l'installation, y compris « none ». Consultez Guardrails. |
Cliquez sur Create key.
Le secret affiché une seule fois
La nouvelle clé est affichée une seule fois, dans la boîte de dialogue Copy your API key :
Figure 3 : La nouvelle clé n'est affichée qu'une fois : copiez-la avant de fermer la boîte de dialogue
"Il s'agit de la seule fois où la clé complète est affichée. Conservez-la dans un endroit sûr."'
Copiez-la dans votre gestionnaire de secrets avant de cliquer sur Done. Une fois cette boîte de dialogue fermée, seule la forme masquée est affichée. Si vous perdez le secret, utilisez Rotate sur la clé pour en obtenir un nouveau.
Modifier une clé
Cliquez sur la ligne d'une clé (ou sur son crayon Edit) pour ouvrir le panneau Configure API key, qui propose les mêmes paramètres qu'à la création (libellé, limites de dépenses, limites de débit, restriction de modèles, remplacement des guardrails) :
Figure 4 : Le panneau Configure API key
Les modifications prennent effet quelques instants après l'enregistrement. Lorsqu'une clé possède des limites quotidiennes ou mensuelles, sa ligne affiche l'utilisation par rapport à celles-ci (Today, This month, Lifetime) ainsi qu'un badge Limit reached lorsqu'une limite est atteinte.
Cycle de vie d'une clé : rotation, révocation, suppression
Chaque action dispose d'une boîte de dialogue de confirmation qui indique précisément ce qui va se passer :
| Action | Effet | Texte de confirmation |
|---|---|---|
| Rotate | Émet un nouveau secret (affiché une seule fois) avec les mêmes paramètres ; l'ancien secret cesse immédiatement de fonctionner. | "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 | Désactive la clé immédiatement, de manière réversible. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Rétablit une clé révoquée (même secret). | Aucune : l'action s'exécute immédiatement. |
| Delete | Supprime définitivement la clé. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Figure 5 : La confirmation Delete API key
Quelle action choisir : effectuez une rotation en cas de soupçon de fuite (le service conserve ses paramètres et son historique : il suffit de mettre à jour le secret) ; révoquez pour suspendre temporairement un système ; supprimez uniquement lorsque l'intégration n'est définitivement plus utilisée.
Se connecter avec une clé
La carte Connecting to the API, sous la liste des clés, affiche l'URL de base et un exemple de requête à copier-coller pour votre environnement. Consultez Connecter votre application pour le guide de démarrage rapide complet avec des exemples de SDK et la gestion des erreurs.