Passer au contenu principal
L’API de Metronome utilise des jetons bearer pour authentifier les requêtes. Cette page décrit comment créer et gérer les jetons.

​
Créer un jeton

Les jetons d’API peuvent être créés via l’application Metronome.
  1. Cliquez sur Connections dans la barre de navigation.
  2. Cliquez sur API tokens & webhooks dans la barre de navigation horizontale de la page affichée.
  3. Cliquez sur le bouton + Add.
  4. Saisissez un nom descriptif pour le jeton et cliquez sur Create new token.
  5. Copiez la chaîne du jeton à un emplacement sécurisé avant de cliquer sur Done.
ENREGISTREZ VOTRE JETONVeillez à enregistrer le jeton que vous créez. Vous ne pouvez plus consulter le jeton complet par la suite.
Créez autant de jetons que nécessaire, en fournissant un nom descriptif pour chacun d’eux. Le nom du jeton est associé aux appels d’API qui l’utilisent, ce qui peut être utile pour suivre les modifications et les requêtes dans les journaux d’audit de Metronome.

​
Utilisation des jetons

Lorsque vous effectuez des appels d’API, fournissez le jeton à l’aide de l’en-tête Authorization. Si vous utilisez le SDK, celui-ci recherche par défaut la clé d’API dans la variable d’environnement METRONOME_BEARER_TOKEN. Consultez la documentation du SDK pour plus de détails. 
from metronome import Metronome

client = Metronome(
  # Defaults to os.environ.get("METRONOME_BEARER_TOKEN") if omitted
  bearer_token="My bearer token",
)
Si votre jeton est valide, vous recevrez une charge utile JSON depuis l’API — soit des données (si l’endpoint renvoie des enregistrements), soit un objet d’erreur JSON 404 si aucune ressource n’est trouvée. Si votre jeton n’est pas valide, vous recevrez une erreur 401 ou 403. Consultez les codes d’état de l’API pour plus de détails.

​
Configuration de Postman

Si vous utilisez Postman :
  1. Importez la spécification OpenAPI de Metronome.
  2. Dans les paramètres de la collection, définissez Authorization sur Bearer Token et utilisez {{api_token}} comme jeton.
  3. Ajoutez api_token aux variables d’environnement Postman.
Consultez notre guide Postman pour des instructions étape par étape.

​
Permissions

Par défaut, les jetons d’API Metronome conservent les mêmes permissions que l’utilisateur qui les a créés. Les jetons d’API Metronome peuvent également être limités en portée afin de réduire les risques et d’appliquer le principe du moindre privilège. Metronome prend en charge la définition de la portée selon :
  • Le niveau d’accès (par exemple, lecture seule)
  • L’environnement (par exemple, bac à sable uniquement)
  • L’endpoint (par exemple, uniquement getCustomers)
Pour ajuster les permissions, contactez votre représentant Metronome.

​
Archivage des jetons

Metronome permet d’archiver les jetons qui ne sont plus utilisés. Pour ce faire, cliquez simplement sur l’icône Corbeille à côté du jeton concerné dans l’interface utilisateur de Metronome. Cette action est irréversible.
BONNES PRATIQUESSuivez les bonnes pratiques de sécurité en supprimant les jetons inutilisés et en effectuant régulièrement la rotation des jetons en cours d’utilisation.