Gérer les clés API
La page API Keys vous permet de créer, d'afficher et de gérer les clés utilisées par vos applications pour appeler l'API FourA.
Afficher vos clés
La page affiche toutes les clés auxquelles vous avez accès : vos clés personnelles, ainsi que chaque clé appartenant à une organisation dont vous êtes membre. L'adhésion est ce qui accorde l'accès, donc un simple membre voit également les clés de l'organisation.
| Colonne | Ce qu'elle affiche |
|---|---|
| Name | Nom d'affichage et, si vous en avez défini une, la description |
| Owner | Personal, ou le nom de l'organisation |
| Key Prefix | Préfixe masqué (pk_live_••••••••) avec un bouton Reveal, ou une icône de cadenas sur une clé obsolète |
| Status | Actif ou Inactif |
| Created | Date de création de la clé |
| Last Used | Date de la dernière request effectuée par la clé |
Recherchez par nom ou par description, filtrez par Actif ou Inactif, et triez par n'importe quel en-tête. L'ordre de tri alterne entre décroissant, croissant, puis désactivé.
Le filtre Owner
Si vous appartenez à au moins une organisation, un menu déroulant Owner apparaît à côté de la barre de recherche : Everything, Personal, ou une entrée par organisation. Il restreint la liste aux clés associées à ce propriétaire, et le même contrôle sur Overview, Metrics, Activity et Proxy suit votre sélection, de sorte que les cinq pages affichent toujours le trafic correspondant.
Créer une clé
Cliquez sur Create Key au-dessus de la liste (Create API key sur la page vide avant votre première clé) et renseignez :
| Champ | Requis | Description |
|---|---|---|
| Name | Oui | Un libellé descriptif, par exemple "production-scraper" ou "staging-test" |
| Description | Non | Notes sur l'utilisation de cette clé |
| Owner | Oui si vous appartenez à une organisation | Personnel, ou toute organisation dont vous êtes membre. Le sélecteur n'apparaît que si vous en avez au moins une. |
Tout membre d'une organisation peut créer une clé lui appartenant, quel que soit son rôle. C'est l'objectif de ce paramètre : l'utilisation d'une clé d'organisation est facturée au propriétaire de l'organisation, évitant ainsi au développeur d'utiliser une clé personnelle qui lui serait directement facturée au lieu de l'entreprise.
La clé complète s'affiche une seule fois juste après sa création dans une boîte de dialogue prête à être copiée. Vous pouvez l'afficher à nouveau plus tard avec Reveal. Les clés utilisent le préfixe pk_live_ et ressemblent à pk_live_a1b2c3d4e5f6.... Vous recevrez un e-mail confirmant la création de la clé.
Révéler une clé
Cliquez sur l'icône en forme d'œil à côté du préfixe masqué d'une clé pour afficher à nouveau son secret complet. Le tableau de bord vous demande de confirmer, puis ouvre une boîte de dialogue avec la clé en clair, un bouton de copie et un court compte à rebours. Une fois le compte à rebours terminé, la boîte de dialogue efface le secret de la page.
Chaque révélation est enregistrée dans le journal d'audit, car elle expose un identifiant actif.
Toute personne avec qui la clé est partagée peut la révéler : son propriétaire personnel, ou tout membre de l'organisation propriétaire.
Clés obsolètes
Les clés créées avant le lancement de la fonctionnalité d'affichage affichent une icône de cadenas au lieu de l'œil et ne peuvent pas être révélées. Seul leur hash a été stocké, le secret d'origine est donc irrécupérable. Pour convertir une ancienne clé, ouvrez le menu d'actions et sélectionnez Regenerate. Le nouveau secret pourra ensuite être révélé à tout moment.
Ce que chaque rôle peut faire
Sur une clé personnelle, vous avez tous les droits. Sur une clé d'organisation, trois niveaux s'appliquent :
| Action | Member | Admin | Owner |
|---|---|---|---|
| Utiliser la clé et l'afficher | Oui | Oui | Oui |
| Renommer la clé, modifier la description | Oui | Oui | Oui |
| Activer ou désactiver la clé | Non | Oui | Oui |
| Régénérer le secret | Non | Oui | Oui |
| Supprimer la clé | Non | Oui | Oui |
| Transférer la clé hors de l'organisation | Non | Non | Oui |
Désactiver et Modifier restent visibles sur la ligne mais sont grisés avec une note explicative. Regenerate, Transfer et Delete n'apparaissent pas dans le menu si votre rôle ne le permet pas. L'API refuse ces mêmes actions, empêchant toute intégration de contourner l'interface.
Cette répartition reflète l'impact de chaque action sur les utilisateurs qui partagent la clé. Le renommage n'a pas d'impact opérationnel. La régénération ou la désactivation interrompt immédiatement l'intégration de chaque collègue. Le transfert d'une clé hors de l'organisation la retire à l'entreprise pour imputer son utilisation sur le forfait du destinataire, ce qui réserve cette action au seul propriétaire.
Modifier une clé
Cliquez sur Edit pour modifier le nom et la description. La propriété de la clé n'est pas modifiée depuis cette boîte de dialogue : utilisez Transfer.
L'option View Metrics dans le menu d'actions ouvre la vue d'ensemble filtrée sur cette clé.
Activation et désactivation
Utilisez Disable ou Enable sur la ligne correspondante. La désactivation d'une clé bloque chaque requête API qui l'utilise, et vous pouvez la réactiver à tout moment. La modification prend effet en quelques secondes.
Régénérer une clé
Si vous suspectez qu'une clé a été compromise, ouvrez le menu d'actions et choisissez Regenerate. Cette opération génère un nouveau secret pour le même identifiant de clé. L'ancien secret cesse immédiatement de fonctionner. Le nom, le propriétaire et tous les autres paramètres restent inchangés.
Le nouveau secret reste consultable après la fermeture de la boîte de dialogue, vous n'avez donc pas besoin de le copier immédiatement.
Transférer une clé
L'option Transfer du menu d'actions permet de transférer une clé entre un compte personnel et une organisation sans régénérer le secret. L'identifiant de la clé, ses métriques et son historique d'activité sont conservés. Seul le propriétaire change, et par conséquent l'imputation de la facturation liée à son utilisation.
| Déplacement | Autorisations requises |
|---|---|
| Clé personnelle vers une organisation | Tout membre de cette organisation |
| Clé d'organisation vers votre compte personnel | Le propriétaire de l'organisation |
| Entre deux organisations | Le propriétaire de l'organisation d'origine |
Une clé transférée dans une organisation rejoint son équipe par défaut "Everyone", ce qui la rend visible par l'ensemble des membres. Une clé transférée hors d'une organisation quitte toutes les équipes auxquelles elle appartenait.
Supprimer une clé
Ouvrez le menu d'actions et choisissez Supprimer. La suppression d'une clé déjà utilisée la désactive : la clé cesse d'authentifier les requêtes et reste dans la liste avec le statut Inactif, afin que l'historique d'Activité et de Métriques conserve son nom. Les clés qui n'ont jamais été utilisées sont définitivement supprimées.
Vous recevrez un e-mail lorsqu'une clé est supprimée.
Clés d'organisation et facturation
L'utilisation d'une clé appartenant à une organisation est décomptée du forfait du propriétaire de l'organisation, quel que soit l'émetteur de la request. La page Usage & Limits du propriétaire comptabilise ces clés aux côtés de ses clés personnelles et sépare les deux.
Liens associés
- Authentication : Fonctionnement des clés API avec l'API
- Organizations : Rôles, membres et accès partagé
- Usage & Limits : Quelles clés sont décomptées de votre forfait
- Dashboard Overview : Toutes les sections du dashboard