Gérez vos clés API dans votre Service Account pour interagir en toute sécurité avec nos API.
Vous pouvez générer des clés API dans votre compte de service pour chaque application nécessitant un accès à l'API Braincube.
Cliquez sur l'icône d'action "manage API Keys" pour ouvrir le volet de droite
et créez une clé API :
Les Scopes vous permettent de restreindre votre jeton à certains segments de l'API. Voici quelques exemples de périmètres requis pour différents usages (ce tableau n'est pas exhaustif) :
| Usage | Périmètre requis (Scope) |
|---|---|
| IOT Live App | SSO_Read, BRAINCUBE |
| braindata-compute node | BRAINCUBE |
ATTENTION : vous ne pouvez accéder à la valeur de la clé API QU'UNE SEULE FOIS lors de sa création. Assurez-vous de sauvegarder la valeur de la clé API dans un emplacement sûr (par exemple, dans un gestionnaire de mots de passe).
Ensuite, envoyez cette clé API dans l'en-tête HTTP x-api-key de votre requête API. Cela authentifiera votre appel API avec les droits d'accès du compte de service.
Vous pouvez révoquer cette clé API à tout moment en cliquant sur le bouton de suppression, ou vous pouvez définir une date d'expiration lors de la création.
REMARQUE :
- Pour des raisons de sécurité, une clé API sur un compte de service n'hérite pas des droits du propriétaire du compte de service, mais uniquement des droits du compte de service lui-même. Par conséquent, il est recommandé d'accorder au compte de service uniquement l'accès aux produits nécessaires.
- La création d'une clé API sur son compte personnel (depuis la page "access token") a été supprimée pour des raisons de sécurité : un compte de service permet de gérer des droits plus restreints.
- Les clés API personnelles existantes continueront de fonctionner. Une bonne pratique serait de remplacer ces clés par des clés sur des comptes de service.