Généralités
Un token API est une chaîne de caractères unique générée pour permettre une authentification et un accès à nos API. Ce token doit être inclus dans chaque requête envoyée à l'API pour identifier et autoriser le client à accéder aux ressources ou aux fonctionnalités offertes par l'API.
Prérequis d'utilisation
Pour générer un token d'API depuis le dashboard, vous devez au préalable vous munir de la clé API de votre compte. Celle ci vous sera demandé dans le cadre de la génération d'un Token d'API.
Si vous ne l'avez pas, ou si vous ne l'avez jamais eu, vous pouvez vous tourner vers le support pour la récupérer.
A noter : La clé ne peut être demandé que par un utilisateur qui a le niveau de droit gestionnaire de compte ou administrateur de compte.
Accès
Accédez à la section Token API depuis la page mon profil, accessible via le raccourci en haut à droite du dashboard.
Gestion des tokens d'API
Création
Créer vos tokens directement via l'action "créer un token API"
Les champs requis de création du token sont :
- Le nom
- La clé API associée au compte pour pouvoir valider la création du token API.
Il est aussi possible de paramétrer une date d'expiration. Ce paramétrage est facultatif et ne sera pas modifiable une fois le token créé.
Une fois les paramètres requis renseignés, vous pourrez faire la création du token. Celui-ci apparaitra dans une pop-up.
Nous vous invitons à le copier et le coller dans un endroit ou vous disposez d'un accès sécurisé. Car une fois la pop-up fermée, il ne sera plus possible de consulter le token.
Vous retrouverez ensuite le token nouvellement créé dans la liste. Vous pouvez en créer plusieurs pour des usages différents.
Modification
Il est possible de modifier le nom du Token une fois que celui-ci est créé et apparait dans la liste des tokens API.
Vous pouvez donc vous servir de cette modification pour donner du contexte et savoir plus facilement dans quelles circonstances le Token est utilisé.
Suppression
Il est possible de supprimer un token API à tout moment. Assurez vous avant la suppression de bien comprendre le contexte de l'utilisation du token pour éviter de faire une interruption de service (si celui-ci est utilisé).
Un message de confirmation de suppression sera affiché avant suppression définitive du token.