Comment créer une clé API Voxbi

Générez une clé API à portée limitée depuis le Cockpit Voxbi en quatre étapes, configurez ses autorisations et sa date d'expiration, puis utilisez-la comme jeton Bearer. Accès administrateur requis.

VT Voxbi team Développeurs

20 juillet 2026

Les clés API permettent à vos propres outils et aux intégrations tierces de communiquer avec Voxbi de manière sécurisée. Vous les créez vous-même dans le Cockpit Voxbi, et chaque clé possède ses propres autorisations et sa propre date d'expiration, ce qui vous permet d'accorder à chaque intégration exactement l'accès dont elle a besoin, sans rien de plus. Ce guide vous accompagne en quatre étapes. Pour une vue d'ensemble de ce que l'API peut faire, consultez la présentation de l'API et des webhooks Voxbi.

Vous pouvez maintenir plusieurs clés actives simultanément, ce qui facilite la séparation des intégrations ou la rotation des accès sans aucune interruption.

Avant de commencer

Vous avez besoin d'un compte administrateur sur votre système téléphonique Voxbi. Les clés API sont gérées dans le Cockpit Voxbi sous Configuration > Intégrations.

Étape 1 : ouvrir Intégrations

Dans le menu latéral du Cockpit, sous Configuration, sélectionnez Intégrations. Cette page liste toutes les intégrations et clés API de votre système téléphonique.

La page Intégrations dans le Cockpit Voxbi, avec le bouton Nouvelle intégration au-dessus de la liste.

Étape 2 : ajouter une nouvelle clé API

Cliquez sur + Nouvelle intégration, ouvrez le menu déroulant Type et choisissez Clé API.

Étape 3 : nommer la clé, puis définir les portées et la date d'expiration

Donnez à la clé un nom descriptif pour pouvoir la reconnaître plus tard (par exemple, le nom de l'intégration à laquelle elle appartient). Définissez ensuite :

Date d'expiration. Le jour où la clé cesse de fonctionner. Laissez ce champ vide pour une clé qui n'expire jamais, ou définissez une date pour les intégrations temporaires et de test afin que la clé se désactive automatiquement.
Portées. Cochez uniquement les ressources et les autorisations dont cette clé a besoin, par exemple Contacts, Historique des appels ou Numéros de téléphone. N'utilisez Tout sélectionner que si une intégration a véritablement besoin de tout.

Les paramètres de clé API dans le Cockpit Voxbi, affichant les portées de ressources que vous pouvez accorder, comme les contacts, les flux d'appels, les numéros de téléphone et l'historique des appels.

Cliquez ensuite sur Enregistrer.

N'accorder que les portées nécessaires à une clé limite les dégâts en cas d'exposition. Lorsqu'une intégration a besoin d'un accès plus étendu par la suite, créez une seconde clé avec les portées supplémentaires plutôt que d'élargir une clé existante.

Étape 4 : copier votre clé

La nouvelle clé apparaît dans le champ Clé API. Utilisez le bouton en forme d'oeil pour la révéler et l'icône de copie pour la récupérer. C'est la valeur que vous envoyez comme jeton Bearer.

Le Cockpit Voxbi confirmant la création de la clé API, avec des boutons pour révéler et copier la clé.

Traitez la clé comme un mot de passe. La révéler ou la copier est enregistré dans le journal d'audit, et si vous la perdez, vous supprimez la clé et en créez une nouvelle plutôt que de chercher à la récupérer.

Utiliser votre clé

Pointez votre requête vers l'URL de base de l'API Voxbi, https://cockpit.voxbi.com/v1/api, et envoyez votre clé dans l'en-tête Authorization en tant que jeton Bearer :

# Remplacez YOUR_API_KEY par la clé que vous avez copiée.
curl https://cockpit.voxbi.com/v1/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

La liste complète des points de terminaison, des paramètres et des formats de réponse se trouve dans la documentation de l'API Voxbi.

Protéger vos clés

Ne jamais coder une clé en dur. Gardez les clés hors du contrôle de source et hors du code côté client. Utilisez des variables d'environnement ou un gestionnaire de secrets.
Une clé par intégration. Des clés séparées vous permettent de révoquer ou de faire tourner un service sans perturber les autres.
Définissez une expiration pour les clés temporaires ou de test afin qu'elles se désactivent automatiquement.
Surveillez le journal d'audit. Chaque révélation et chaque copie est enregistrée, ce qui vous permet de le consulter si vous suspectez qu'une clé a été partagée ou utilisée de manière abusive.

Questions fréquentes

Puis-je avoir plusieurs clés API ?

Oui. Vous pouvez en maintenir plusieurs actives simultanément, chacune avec son propre nom, ses propres portées et sa propre date d'expiration. Attribuer une clé distincte à chaque intégration est l'approche recommandée.

Que se passe-t-il lorsqu'une clé expire ?

Elle cesse de fonctionner à sa date d'expiration et les requêtes qui l'utilisent sont rejetées. Créez une nouvelle clé et mettez à jour votre intégration avant que l'ancienne n'expire.

J'ai perdu ma clé. Puis-je la voir à nouveau ?

Vous pouvez la révéler à nouveau depuis la page Intégrations avec le bouton en forme d'oeil. Si vous n'y avez plus accès, supprimez cette clé et générez-en une nouvelle. La révélation d'une clé est enregistrée dans le journal d'audit.

Comment modifier les autorisations d'une clé ?

Ouvrez l'intégration et ajustez ses portées. Pour réduire les accès sans interrompre une intégration en cours d'exécution, créez une nouvelle clé avec des portées plus restrictives puis basculez vers celle-ci.

Besoin d'aide ?

Si vous êtes bloqué, écrivez-nous à hello@voxbi.com. Pour découvrir ce que vous pouvez construire une fois que vous avez une clé, consultez la présentation de l'API et des webhooks Voxbi ou connectez n'importe quel CRM via l'API.