Gérer les clés API

Option requise : API / Integration
Profils autorisés : Brand manager

La page API de vos paramètres vous permet de créer et de gérer les clés qui connectent des outils externes, comme un ERP ou un outil de BI, à vos données Le New Black. Cet article explique comment créer une clé avec les accès nécessaires, puis la révoquer ou la supprimer lorsqu'elle n'est plus utilisée.
 

• Créer une clé API
• Révoquer une clé API
• Supprimer une clé API
   

Créer une clé API

Si vous utilisez déjà l'API pour une intégration externe, votre clé existante apparaît dans la liste sous le nom Historical key. Ses permissions n'ont pas changé et votre intégration continue de fonctionner comme avant. Vous pouvez créer autant de clés supplémentaires que nécessaire, chacune avec ses propres accès. Par exemple, vous pouvez créer une clé pour votre outil de BI qui permet uniquement de lire les données.
 

1. Cliquez sur la ⚙️ roue de paramètres > Paramètres, puis sélectionnez API dans la section Accès et sécurité.
    
2. Cliquez sur Créer une clé.
    
3. Dans la fenêtre, saisissez un nom dans le champ Nom. Choisissez un nom qui identifie l'outil qui utilisera la clé, par exemple « Outil BI », afin de la reconnaître facilement dans votre liste.
    
4. Sous La clé doit communiquer avec : sélectionnez L'API Wholesale v2, L'API Analytics, ou les deux.
    
5. Sous Permissions, sélectionnez le niveau d'accès :
   • Lecture seule : la clé peut uniquement lire les données.
   • Lecture et écriture : la clé peut aussi créer, mettre à jour et supprimer des données.
      
6. Cliquez sur Créer la clé.
    
7. Cliquez sur les icônes de copie à côté de Identifiant client et Secret client, puis enregistrez ces deux valeurs de manière sécurisée.
    
8. Cochez J'ai enregistré le secret client de manière sécurisée puis cliquez sur Terminé.
   Le secret client ne s'affiche qu'une seule fois. Une fois la fenêtre fermée, il ne peut plus être affiché. En cas de perte du secret, créez une nouvelle clé et révoquez la précédente.

Un message de confirmation s'affiche en haut de la page et la nouvelle clé est ajoutée à votre liste. Pour savoir qui a créé une clé, survolez sa date de création avec votre souris. Cette information n'est pas disponible pour la Historical key.
 

Vos développeurs ou intégrateurs peuvent ensuite utiliser l'identifiant client et le secret client pour se connecter à l'API. Vous pouvez aussi accéder à la documentation API en cliquant sur l'icône en forme de chapeau de diplômé à côté de Créer une clé.
 

Révoquer une clé API

Révoquer une clé la désactive. C'est utile par exemple lorsque vous changez d'ERP ou lorsqu'une personne disposant d'un accès privilégié quitte votre entreprise.

1. Cliquez sur ⋯ à côté de la clé.
2. Sélectionnez Révoquer.

Un message de confirmation s'affiche en haut de la page et la clé apparaît désormais grisée et barrée dans votre liste. Les outils qui utilisent cette clé ne peuvent plus accéder à vos données. Vous pouvez conserver une clé révoquée dans la liste pour garder un historique des clés utilisées par le passé.

Avant de révoquer une clé, vous pouvez consulter la colonne Dernière utilisation pour vérifier si elle est encore utilisée.
 

Supprimer une clé API

Seule une clé révoquée peut être supprimée. Si vous n'avez pas besoin de conserver son historique, vous pouvez la retirer complètement de votre liste. La suppression d'une clé est irréversible.

1. Cliquez sur ⋯ à côté de la clé révoquée.
2. Sélectionnez Supprimer.

Un message de confirmation s'affiche en haut de la page et la clé est retirée de votre liste.