Guides du produit

Clés API

Pour utiliser l'API Wbiztool, ou une intégration qui vous demande vos identifiants, vous avez besoin de trois éléments issus du tableau de bord :

Identifiant	Champ API	Où le trouver
API Client ID	`client_id`	Paramètres → Clés API, en haut de la page
Clé API	`api_key`	Paramètres → Clés API
WhatsApp Client ID	`whatsapp_client`	La colonne ID Client WhatsApp dans les paramètres WhatsApp

Avant de commencer#

Vous devez être Administrateur de l'espace de travail pour voir, créer ou supprimer des clés API. Consultez Rôles et autorisations.
Sélectionnez d'abord le bon espace de travail. Les clés appartiennent à l'espace de travail sélectionné au moment de leur création, et les requêtes API effectuées avec une clé agissent sur cet espace de travail. Consultez Passer à un autre espace de travail.
Les comptes de démonstration ne peuvent pas utiliser l'API.

Trouver votre API Client ID#

Ouvrez Paramètres → Clés API. La carte Aperçu API affiche ID Client API : suivi d'un nombre. Utilisez ce nombre comme client_id dans chaque requête. Il est identique pour toutes les clés de l'espace de travail.

Créer une clé API#

Ouvrez Clés API
Allez dans Paramètres et cliquez sur l'onglet Clés API, ou ouvrez directement /settings/#api-keys.
Créez la clé
Sous Nouvelle Clé API, cliquez sur Créer Nouveau. Un message de réussite confirme que la clé a été générée, et elle apparaît dans le tableau.
Copiez la clé complète
La colonne Clé API n'affiche que le début et la fin de chaque clé. Cliquez sur le bouton de copie à côté (Copier la Clé API Complète) pour copier la clé entière, puis collez-la dans votre application ou votre intégration.

Les clés sont nommées automatiquement d'après le nombre de clés de l'espace de travail (API Key 1, API Key 2, etc.) et ne peuvent pas être renommées. Après la suppression d'une clé, une nouvelle clé peut recevoir le même nom qu'une clé existante : distinguez donc les clés par leurs premiers et derniers caractères et par la date Créé. Les clés n'expirent pas : une clé fonctionne jusqu'à ce que vous la supprimiez.

Limite#

Un espace de travail peut avoir jusqu'à 10 clés API à la fois. Lorsque vous atteignez la limite, vous voyez « You have reached the maximum limit of 10 API keys per organization. » (limite maximale de 10 clés API par organisation atteinte). Supprimez une clé que vous n'utilisez plus pour en créer une nouvelle.

Le tableau des clés API#

Colonne	Signification
Étiquette	Le nom de la clé, par exemple API Key 1.
Clé API	Les premiers et derniers caractères de la clé. Utilisez le bouton de copie pour obtenir la clé complète.
Créé	La date de création de la clé.
Statut	Toujours Actif. Les clés supprimées disparaissent du tableau.
Actions	Supprimer supprime la clé.

Supprimer une clé API#

Trouvez la clé
Dans Paramètres → Clés API, repérez la clé dans le tableau.
Supprimez-la
Cliquez sur Supprimer, puis sur Oui, Supprimer la Clé API.

La suppression d'une clé est irréversible. Toute application qui l'utilise encore cesse immédiatement de fonctionner et reçoit Auth Error: invalid api key. Mettez d'abord à jour vos applications avec une nouvelle clé.

WhatsApp Client ID#

Chaque numéro WhatsApp connecté possède son propre identifiant. La plupart des endpoints de messagerie en ont besoin dans le champ whatsapp_client pour choisir le numéro qui envoie le message.

Ouvrez les paramètres WhatsApp et lisez la colonne ID Client WhatsApp à côté de chaque numéro. Consultez Connecter votre numéro WhatsApp si vous n'en avez pas encore connecté.

Tester vos identifiants#

Appelez Vérifier les identifiants (POST /api/v1/me/) avec votre client_id et votre api_key, et éventuellement un whatsapp_client. Cet appel confirme qu'ils fonctionnent ensemble, sans rien envoyer ni consommer de messages. Si le whatsapp_client n'appartient pas à l'espace de travail, la réponse est Invalid WhatsApp Client ID.

En cas de fuite d'une clé API#

Toute personne disposant de votre clé API et de votre API Client ID peut envoyer des messages depuis vos numéros WhatsApp et consommer les messages de votre espace de travail.

Créez une clé de remplacement
Dans Paramètres → Clés API, cliquez sur Créer Nouveau et copiez la nouvelle clé.
Mettez à jour vos applications
Remplacez l'ancienne clé dans toutes les applications et intégrations qui l'utilisaient.
Supprimez la clé exposée
Cliquez sur Supprimer sur la clé exposée. Elle cesse immédiatement de fonctionner.
Vérifiez les abus
Examinez les messages récents dans les Rapports pour repérer ceux que vous n'avez pas envoyés.

Considérez aussi comme confidentiel l'email « WbizTool Alert - WhatsApp Connected Successfully! » : il est envoyé au créateur de l'espace de travail lors de la première connexion d'un numéro et peut contenir l'une de vos clés API.

Dépannage#

Problème	Ce qu'il faut vérifier
L'onglet Clés API affiche Aucune Clé API Trouvée alors que des clés existent	Vous n'êtes pas Administrateur dans cet espace de travail, ou un autre espace de travail est sélectionné.
« You don't have permission to create API keys in this space. » (vous n'avez pas l'autorisation de créer des clés API dans cet espace)	Seuls les Administrateurs peuvent créer ou supprimer des clés. Le bouton Générer une Nouvelle Clé API d'un tableau vide s'affiche pour tout le monde, mais ne fonctionne que pour les Administrateurs.
« You have reached the maximum limit of 10 API keys per organization. »	Supprimez une clé que vous n'utilisez plus.
`Auth Error: invalid api key`	La clé a été supprimée ou mal saisie, ou le `client_id` n'appartient pas au même espace de travail que la clé. Si une nouvelle clé et l'API Client ID affiché sur la page échouent toujours, contactez le support (les espaces de travail plus anciens peuvent afficher un API Client ID qui ne fonctionne qu'avec les clés créées par le créateur de l'espace de travail).
`Auth Error - Please send correct API key and Client id`	`api_key` est absent de la requête.
`Invalid client id.` (ou `Invalid Client Id` sur certains endpoints)	`client_id` est absent ou n'est pas un nombre. Sur Vérifier les identifiants, un `client_id` ou une `api_key` absent renvoie simplement `Auth Error` ; `Invalid Client Id` y signifie que la valeur n'est pas un nombre. Copiez-le depuis la carte Aperçu API.
Les requêtes agissent sur le mauvais espace de travail	La clé a été créée dans un autre espace de travail. Changez d'espace de travail et créez-y une clé.
`Demo Account can not access apis`	Les comptes de démonstration ne peuvent pas utiliser l'API. Inscrivez-vous pour obtenir un compte gratuit.