Passer au contenu principal
Pour appeler l’API Bodyguard, votre application s’authentifie avec une clé API. Dans le dashboard, les clés API appartiennent à un compte de service : le compte de service est l’identité de votre application ou de votre processus automatisé (un outil de monitoring, un script, un pipeline de données, un environnement de staging ou de production), et la clé API est l’identifiant qu’il utilise pour s’authentifier.
Les comptes de service et les clés API ne sont pris en charge que par la nouvelle API.

​
Prérequis

Vous avez besoin du rôle Admin dans votre organisation pour créer et gérer des comptes de service et des clés API. Les Members et les Editors peuvent les consulter.

​
Étapes

1

Créer un compte de service

  1. Cliquez sur l’icône d’engrenage dans le menu de gauche pour ouvrir Settings, puis sélectionnez Identity & access management.
    Dashboard Bodyguard avec l'icône d'engrenage Settings dans le menu de gauche et l'entrée Identity & access management en surbrillance

    Settings > Identity & access management

  2. Ouvrez l’onglet Service accounts et cliquez sur Create service account.
    Onglet Service accounts avec le bouton Create service account en surbrillance

    Onglet Service accounts

  3. Remplissez le formulaire. Les numéros correspondent à la capture d’écran ci-dessous. 1. Saisissez un Name.
    2. Ajoutez une Description (facultative).
    3. Vérifiez l’accès aux sources. Grant full source access est activé par défaut : le compte de service peut accéder à toutes les sources, actuelles et futures.
    4. Cliquez sur Create.
    Fenêtre Create service account avec le champ Name (1), le champ Description (2), l'option Grant full source access (3) et le bouton Create (4) en surbrillance

    Formulaire de création d'un compte de service

    Utilisez un nom clair qui identifie l’application ou l’environnement qui utilise le compte. Par exemple, nommez-le Production Monitoring et décrivez-le avec Used by the production monitoring integration.
  4. Votre compte de service apparaît dans la liste. Cliquez sur l’icône d’agrandissement à la fin de sa ligne pour ouvrir sa page de détails.
    Liste des comptes de service avec le nouveau compte en surbrillance et une flèche pointant vers l'icône d'agrandissement qui ouvre sa page de détails

    Ouvrir la page de détails du compte de service

2

Générer une clé API

  1. Sur la page de détails du compte de service, cliquez sur Generate an API key.
    Page de détails du compte de service avec le bouton Generate an API key en surbrillance

    Page de détails du compte de service

  2. Saisissez un nom et une description facultative. Pour que la clé expire, cochez Set an expiration date et choisissez une date. Cliquez ensuite sur Generate and continue.
    Fenêtre Generate an API key avec les champs Name, Description, Set an expiration date et Expiration date, et le bouton Generate and continue

    Formulaire de génération d'une clé API

  3. Copiez votre clé API avec l’icône de copie et conservez-la en lieu sûr, puis cliquez sur Done. La clé n’est affichée qu’une seule fois, lors de sa création. Il ne sera plus possible de l’afficher ensuite.
    Fenêtre Your API key has been generated avec le champ API key et son icône de copie en surbrillance

    Clé API affichée à la création

Vous pouvez ensuite modifier, désactiver ou supprimer une clé depuis le menu ⋮ à la fin de sa ligne. La modification d’une clé ne change que son nom, sa description et sa date d’expiration : vous ne pouvez ni changer ni afficher sa valeur. Si vous perdez la valeur d’une clé, générez-en une nouvelle.
Ligne d'une clé API avec son menu ouvert, affichant les actions Edit API key, Deactivate et Delete

Actions sur une clé API

La désactivation d’un compte de service ne désactive pas ses clés API. Gérez les clés séparément si nécessaire.
3

Utiliser votre clé API

Envoyez la clé dans l’en-tête Authorization de chaque requête, avec le schéma ApiKey (sensible à la casse) :
En-tête Authorization
Consultez Authentification pour les en-têtes requis et les erreurs d’authentification, et le Démarrage rapide pour une première requête.
Gardez votre clé API secrète et ne l’exposez jamais dans du code côté client.

​
Étapes suivantes

Introduction à l'API

Authentifiez-vous et envoyez votre première requête.

Connecter votre webhook

Recevez des notifications sur votre endpoint.