Documentation BizCortex

Clés API

Des clés qui permettent à d’autres programmes d’accéder aux données de votre entreprise via l’API REST.

Les clés API donnent aux intégrations l’accès à cette entreprise. Traitez ces clés comme des mots de passe. Ouvrez "Paramètres" puis l’onglet "Clés API". Le tableau indique le nom, le préfixe (les premiers caractères de la clé), le rôle, la date de création, "Dernière utilisation", "Expire le" et le statut Actif ou Révoquée.

Clés API
Capture de cet écran

Qui peut l’utiliser

  • Propriétaire
  • Administrateur

Étapes

  1. 1. Créer une clé

    Cliquez sur "Créer une clé". Saisissez un nom, par exemple "DATEV Export", choisissez le rôle et éventuellement une date d’expiration. Enregistrez.

  2. 2. Copier la clé

    La boîte de dialogue "Clé API créée" affiche la clé une seule fois. Cliquez sur le bouton de copie et conservez la clé en lieu sûr. Elle ne sera plus jamais affichée.

  3. 3. Révoquer une clé

    Ouvrez le menu de la ligne et choisissez "Révoquer". Confirmez "Révoquer la clé ?". La clé cesse immédiatement de fonctionner.

Champs et options

Nom

Obligatoire. Vous aide à reconnaître l’intégration.

Rôle

Les autorisations de la clé, au maximum celles de votre propre rôle. Propriétaire ne peut pas être choisi. Par défaut : Lecteur.

Expire le

Date facultative après laquelle la clé ne fonctionne plus.

Conseils

  • Créez une clé par intégration afin de pouvoir la révoquer sans affecter les autres.
  • Attribuez à une clé le rôle le plus restreint dont elle a besoin. Un outil de reporting n’a généralement besoin que du rôle Lecteur.
  • Un fournisseur d’identité peut désactiver automatiquement les utilisateurs qui quittent l’entreprise via l’interface SCIM. Il lui faut une clé avec le rôle Administrateur.

Bon à savoir

  • Seule une empreinte de la clé est stockée. Si vous perdez la clé, révoquez cette clé et créez une nouvelle clé.
  • Lorsqu’un utilisateur quitte l’entreprise, les clés API qu’il a créées sont également révoquées.
  • La création et la révocation des clés sont consignées dans le journal d’audit.

Voir aussi