Configurer les jetons d'API

Important

Cette fonctionnalité est soumise au feature flag Domaine Technique > Libellé Jetons Api.

Le menu Jetons d’API permet de gérer des jetons API pour les utilisateurs techniques d’Akuiteo. Ces jetons sont utilisés exclusivement pour l’accès aux ressources API Akuiteo, en remplacement de l’authentification OAuth2. Ils permettent d’identifier et d’authentifier les applications tierces accédant aux ressources API d'Akuiteo.

Les informations de configuration des jetons sont définies dans la Console d'administration, depuis le menu Sécurité > Jetons d'API.

1 Depuis l'écran Jetons d'API, cliquez sur Créer un jeton d'API en haut à droite de l'écran.
2 Dans la fenêtre qui s'affiche, renseignez les champs suivants :
Champ Description
Utilisateur

Sélectionnez depuis la liste déroulante l'utilisateur du jeton.

Cette liste affiche uniquement les utilisateurs techniques faisant partie de la société à la date de la création. Les utilisateurs techniques sont les utilisateurs qui ont la case Utilisateur technique ? cochée sur leur fiche utilisateur (Tiers > Gestion des utilisateurs > onglet Utilisateur > section Informations générales).
Nom du jeton Renseignez le nom du jeton.
Date d'expiration

Renseignez une date d'expiration pour le jeton. Si aucune date n'est renseignée, la date du jour sera automatiquement appliquée au jeton.

Lorsque la date d'expiration est dépassée, il n'est plus possible d'utiliser ce jeton.
3 Cliquez sur Créer.

Une fenêtre d'information contenant le jeton associé au jeton d'API créé est affichée.

4 Cliquez sur :
  • pour afficher le jeton.
  • Copier dans le presse-papiers pour copier le jeton. Cette action entraîne la fermeture de la fenêtre.
  • Annuler pour fermer la fenêtre.

Important

Il n'est plus possible de consulter le jeton lorsque la fenêtre est fermée.

Le jeton d'API est créé. Il est visible dans le tableau des jetons et peut être utilisé. La valeur Valide est affichée dans la colonne Statut.

La régénération d'un jeton d'API permet de rallonger la période de validité d'un même jeton sans avoir à ressaisir toutes les informations lors de la création.

1 Depuis le tableau des jetons, placez-vous sur la ligne du jeton à régénérer puis cliquez sur dans la colonne Actions.
2 Dans la fenêtre affichée, renseignez la nouvelle Date d'expiration du jeton. Lorsque aucune date n'est renseignée, une durée de 1 an est appliquée par défaut.
3 Cliquez sur Créer.

Une fenêtre d'information contenant le jeton associé au jeton d'API créé est affichée.

4 Cliquez sur :
  • pour afficher le jeton.
  • Copier dans le presse-papiers pour copier le jeton. Cette action entraîne la fermeture de la fenêtre.
  • Annuler pour fermer la fenêtre.

Le jeton est régénéré. La nouvelle date d'expiration du jeton est affichée dans la colonne Date d'expiration et la valeur Valide est affichée dans la colonne Statut.

1 Depuis le tableau des jetons, placez-vous sur la ligne du jeton à révoquer puis cliquez sur dans la colonne Actions.
2 Confirmez l'action.

Le jeton est révoqué. Le jeton est visible dans le tableau, la colonne Date de révocation est renseignée avec la date du jour et la valeur Révoqué est affichée dans la colonne Statut. Il n'est plus possible d'utiliser ce jeton.

1 Depuis le tableau des jetons, placez-vous sur la ligne du jeton à supprimer puis cliquez sur dans la colonne Actions.
2 Confirmez l'action.

Le jeton est supprimé. Il n'est plus visible dans le tableau.

1 Renseignez les champs suivants pour configurer la connexion :
Champ Description
Adresse e-mail à notifier lors de l'expiration des jetons d'API

Renseignez l'adresse e-mail de la personne à notifier lorsqu'un jeton d'API va expirer.
Délai de rappel avant expiration (jours)

Renseignez le nombre de jours avant l'expiration du jeton à partir duquel une notification doit être envoyée à l'adresse paramétrée. Si le champ est laissé vide alors un délai de 30 jours est appliqué par défaut.
2 Cliquez sur Enregistrer pour chaque champ renseigné ou modifié afin de prendre en compte la valeur renseignée.

Les notifications d'expiration sont paramétrées.