Aller au contenu

Clés API

Les clés API permettent aux applications externes d'interagir avec votre compte Voxum de manière programmatique. Utilisez-les pour connecter des systèmes d'inventaire, intégrer avec d'autres logiciels ou créer des solutions personnalisées.

Que sont les clés API ?

Une clé API est comme un mot de passe qui permet à d'autres logiciels d'accéder à vos données Voxum en toute sécurité. Chaque clé :

  • Est unique à votre compte
  • Peut être révoquée si elle est compromise
  • Suit quand elle a été utilisée en dernier
  • A des permissions limitées

Quand vous avez besoin de clés API

Vous pourriez avoir besoin d'une clé API pour :

  • Intégration d'inventaire - Mises à jour automatisées de l'inventaire
  • Connexion CRM - Synchronisation des données de prospects
  • Applications personnalisées - Construire sur l'API de Voxum
  • Outils tiers - Connecter d'autres logiciels d'entreprise

Note

Si vous utilisez seulement le panneau d'administration pour gérer votre chatbot, vous n'avez pas besoin de clés API.

Accéder aux clés API

  1. Cliquez sur Clés API dans le menu de gauche
  2. Vous verrez une liste de vos clés existantes
  3. Options pour créer de nouvelles clés ou révoquer les existantes

Page Clés API

Créer une clé API

Étape 1 : Cliquez sur Créer

Cliquez sur le bouton Créer une clé API.

Étape 2 : Nommez votre clé

Donnez à la clé un nom descriptif qui indique son objectif :

  • ✅ « Intégration inventaire »
  • ✅ « Sync CRM »
  • ✅ « Tests développeur »
  • ❌ « Clé 1 »
  • ❌ « Test »

Étape 3 : Copiez la clé

Important : La clé complète n'est affichée qu'une seule fois !

  1. Copiez la clé immédiatement
  2. Stockez-la en sécurité (gestionnaire de mots de passe, note sécurisée)
  3. Ne la partagez jamais publiquement

Clé API créée

Sauvegardez votre clé

Si vous perdez la clé, vous devrez en créer une nouvelle. La clé complète ne peut pas être récupérée après avoir quitté cette page.

Gérer les clés API

Voir les clés

Votre liste de clés affiche :

  • Nom - L'étiquette que vous avez donnée à la clé
  • Aperçu de la clé - Premiers caractères (masqués)
  • Créée - Quand la clé a été créée
  • Dernière utilisation - Quand elle a été utilisée en dernier (utile pour l'audit)
  • Statut - Active ou révoquée

Révoquer une clé

Si une clé est compromise ou n'est plus nécessaire :

  1. Trouvez la clé dans votre liste
  2. Cliquez sur Révoquer
  3. Confirmez l'action

Les clés révoquées cessent immédiatement de fonctionner. Tous les systèmes utilisant cette clé ne pourront plus se connecter.

Astuce

Révoquez plutôt que de supprimer les clés que vous n'utilisez pas. Cela garde un historique des clés qui ont existé.

Bonnes pratiques de sécurité

Gardez les clés secrètes

  • Ne partagez jamais les clés par courriel
  • Ne commitez pas les clés dans les dépôts de code
  • N'incluez pas les clés dans le code côté client

Utilisez des noms descriptifs

Nommez les clés par leur objectif pour savoir laquelle révoquer en cas de problème.

Faites une rotation des clés périodiquement

Pour les environnements haute sécurité, créez de nouvelles clés périodiquement et révoquez les anciennes.

Surveillez l'utilisation

Vérifiez la date « Dernière utilisation » pour identifier les clés inutilisées ou les activités inhabituelles.

Limitez l'accès

Ne créez des clés que lorsque nécessaire. Moins de clés = moins de risques.

Utiliser les clés API

Lors des requêtes API, incluez votre clé dans l'en-tête :

X-API-Key: votre-cle-api-ici

Exemple :

curl -H "X-API-Key: vx_abc123..." \
     https://app.voxum.ai/api/endpoint

Pour les développeurs

Consultez la documentation API pour les points de terminaison et formats de requête spécifiques.

Dépannage

Erreur « Non autorisé »

  • Vérifiez que la clé est correcte (pas d'espaces supplémentaires)
  • Vérifiez que la clé n'a pas été révoquée
  • Assurez-vous que le nom de l'en-tête est exactement X-API-Key

La clé ne fonctionne pas

  • Assurez-vous d'avoir copié la clé complète
  • Vérifiez si la clé a été révoquée
  • Vérifiez que vous utilisez le bon point de terminaison

Clé perdue

  • Vous ne pouvez pas récupérer une clé perdue
  • Créez une nouvelle clé avec le même objectif
  • Mettez à jour vos systèmes avec la nouvelle clé
  • Révoquez l'ancienne clé

Prochaines étapes