API Clés

Les API clés sont gérées au niveau de l'organisation avec un contrôle d'accès basé sur le rôle (RBAC). Chaque clé peut être affectée d'un rôle organisationnel et d'optionnels rôles par application, vous donnant un contrôle finement granulaire sur ce que chaque clé peut accéder.

Où sont les API clés gérées?

Naviguez vers Paramètres > Organisation > Clés API à console.capgo.app/settings/organisation/api-clés.

La page affiche deux sections :

• Clés RBAC — Clés avec des rôles affectés (recommandé). Ces clés utilisent le nouveau système de permission basé sur le rôle.
• Clés Legacy — Anciennes clés qui utilisent le système de mode simple (read, upload, write, allSans affectation de rôle.

Comment créer une nouvelle clé API ?

1. Cliquez sur le ”+” bouton en haut de la table des clés RBAC.

2. Remplissez les informations de la clé:

   • Nom (obligatoire) — Un étiquette descriptive pour la clé (par exemple « Déployer CI/CD », « Lecture seule de surveillance »).
   • Créer une clé sécurisée (facultatif) — Lorsque sélectionné, la clé sera hachée côté serveur. La clé au texte brut est affichée seulement une fois après la création. Vous ne pourrez pas le récupérer ultérieurement.
   • Fixer la date d'expiration (facultatif) — Sélectionnez une date après laquelle la clé cesserait de fonctionner. Certaines organisations imposent une expiration obligatoire via une politique.

3. Sélectionner un Rôle de l'organisation — Cela définit les permissions de base de la clé à travers l'ensemble de l'organisation. Les rôles disponibles (selon votre niveau de rôle) :

   • None — Aucun accès à l'échelle de l'organisation ; la clé n'a accès qu'aux applications individuellement assignées.
   • Member — Accès de lecture de base à l'organisation.
   • Admin — Accès administratif complet à l'organisation (hérite de l'accès à tous les applications).

4. Si la clé doit créer des organisations à travers le public API, activez Permettre la création d'organisations.

   Cela ajoute l'accès global org.create Cette permission est disponible lorsque la clé a un rôle d'organisation Admin. Lorsque cette clé crée une nouvelle organisation, Capgo attribue automatiquement la clé en tant que Super Admin sur cette nouvelle organisation.

5. Si le rôle d'org sélectionné n'est pas Admin, vous pouvez ajouter Accès par application:

   • Cliquez ”+ Ajouter une application” pour ouvrir le sélecteur d'applications.
   • Sélectionnez une ou plusieurs applications, puis attribuez un rôle à chacune :
     • App Reader — Accès en lecture seule à l'application.
     • App Uploader — Peut télécharger de nouveaux bundles.
     • App Developer — Peut gérer la configuration et les déploiements de l'application.
     • App Admin — Accès complet à l'application.

6. Cliquez “Créer”.

7. Si vous avez coché « Créer une clé sécurisée », un modal affichera la clé en texte brut. Copiez-le immédiatement — il ne peut pas être récupéré après la fermeture de la fenêtre contextuelle.

Comment gérer (éditer) une clé API?

Cliquez sur l'icône de tournevis (Gérer) sur n'importe quelle clé RBAC de la liste. Cela ouvre la page détaillée de la clé où vous pouvez : Changer le nom de la clé

• Mettre à jour le nom de la clé Mettre à jour le rôle de l'organisation.
• Mettre à jour le rôle de l'organisation Mettre à jour le rôle de l'organisation.
• Activer ou désactiver Permettre la création d'organisations lorsque la clé a un rôle d'organisation Admin.
• Ajouter, supprimer ou modifier les rôles par application.

Cliquez “Sauvegarder les modifications” lorsque vous avez terminé.

Comment régénérer une clé API ?

Pour régénérer la valeur secrète d'une clé API, cliquez sur le Icône de rafraîchissement (Réinitialiser) sur n'importe quelle touche de la liste.

Un dialogue de confirmation apparaîtra. Après confirmation :

• Pour les clés sécurisées (hachées): Une nouvelle clé au texte brut est générée et affichée une fois dans un modal. Copiez-la immédiatement.
• Pour les clés au texte brut: La valeur de la clé est régénérée côté serveur.

Toute intégration utilisant la valeur de la clé ancienne cessera de fonctionner immédiatement.

Comment supprimer une clé API ?

Cliquez sur l'icône de poubelle sur n'importe quelle clé de la liste. Confirmez la suppression dans le dialogue.

La clé est révoquée immédiatement — toute requête utilisant cette clé échouera.

Clés héritées

Si vous voyez des clés dans la section Clés héritées qui n'ont pas d'affectations de rôle, celles-ci utilisent le système de permission basé sur le mode (read, upload, write, allplus ancien). Elles fonctionnent toujours mais ne bénéficient pas des permissions RBAC fines.

Les clés de legacy peuvent être régénérées et supprimées de la liste, mais ne peuvent pas être éditées pour ajouter des rôles RBAC. Nous recommandons de créer de nouvelles clés RBAC et de supprimer les clés de legacy lorsque possible.

Si vous avez besoin de gérer les clés de legacy directement, vous pouvez toujours y accéder à console.capgo.app/dashboard/apikeys. Cette page est obsolète et sera supprimée dans une mise à jour future.

Continuez à partir des API Clés

Si vous utilisez API Clés pour planifier le tableau de bord et les opérations de API, connectez-le avec API Aperçu pour les détails d'implémentation dans API Aperçu, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, Appareils pour les détails d'implémentation dans Appareils, et Bundles pour les détails d'implémentation dans Bundles.