Premiers pas

API de vérification des identifiants

Utilisez cette API pour valider vos identifiants avant d'effectuer d'autres appels API. Elle confirme que votre client_id et votre api_key fonctionnent ensemble et, en option, qu'un ID de numéro WhatsApp appartient à votre espace de travail. Elle n'envoie rien et ne consomme aucun crédit.

POSThttps://wbiztool.com/api/v1/me/

Corps: JSON ou champs de formulaire

Exemple rapide#

curl -X POST https://wbiztool.com/api/v1/me/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

import requests

response = requests.post(
    "https://wbiztool.com/api/v1/me/",
    json={
        "client_id": 12345,
        "api_key": "YOUR_API_KEY",
        "whatsapp_client": 678,
    },
    timeout=30,
)
result = response.json()  # read the body even when the HTTP code is 400 or 403

if result["status"] == 1:
    print("Credentials OK for", result["name"])
else:
    print("Failed:", result["message"])

// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/me/", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    client_id: 12345,
    api_key: "YOUR_API_KEY",
    whatsapp_client: 678,
  }),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403

if (result.status === 1) {
  console.log("Credentials OK for", result.name);
} else {
  console.error("Failed:", result.message);
}

<?php
$payload = [
    'client_id'       => 12345,
    'api_key'         => 'YOUR_API_KEY',
    'whatsapp_client' => 678,
];

$ch = curl_init('https://wbiztool.com/api/v1/me/');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode($payload),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (($result['status'] ?? 0) === 1) {
    echo 'Credentials OK for ' . $result['name'];
} else {
    echo 'Failed: ' . ($result['message'] ?? 'no response');
}

Remplacez 12345, YOUR_API_KEY et 678 par vos propres valeurs. Omettez whatsapp_client si vous voulez seulement tester la clé. Consultez Authentification pour savoir où les trouver.

Paramètres de la requête#

client_idintegerobligatoire: Votre ID client API, dans Paramètres → Clés API.
api_keystringobligatoire: Votre clé API, sur cette même page.
whatsapp_clientintegerfacultatif: ID de l'un de vos numéros WhatsApp, dans les paramètres WhatsApp. Envoyez-le pour vérifier également que cet ID appartient à l'espace de travail de cette clé API. Un numéro que vous avez supprimé du tableau de bord passe quand même ce contrôle. Seul l'ID est vérifié ; cela ne vous indique pas si le numéro est connecté. Utilisez pour cela Statut de connexion.

Réponse#

Une requête réussie renvoie le code HTTP 200 :

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}

Champ	Type	Description
`status`	integer	`1` si les identifiants sont valides, `0` sinon.
`message`	string	`Okay` en cas de succès, sinon l'erreur.
`name`	string	Le nom d'utilisateur de la personne qui a créé l'espace de travail. Si vous avez envoyé `whatsapp_client`, le numéro de téléphone correspondant est ajouté après `-`. Présent uniquement en cas de succès.

Erreurs#

Tous les échecs sur cet endpoint renvoient le code HTTP 400, sauf un client_id non numérique, qui renvoie le code HTTP 403. Le corps contient toujours status à 0 :

{ "status": 0, "message": "Auth Error: invalid api key" }

Message	Comment corriger
`Auth Error`	Envoyez à la fois `client_id` et `api_key` dans le corps d'une requête `POST`, en JSON valide ou en champs de formulaire. Ce message apparaît également lorsque `whatsapp_client` n'est pas un nombre.
`Invalid Client Id`	Envoyez `client_id` sous forme de nombre entier, par exemple `12345`.
`Auth Error: invalid api key`	Vérifiez que la clé existe, n'a pas été supprimée et appartient à ce `client_id`.
`Invalid WhatsApp Client ID`	Cet ID `whatsapp_client` ne fait pas partie de l'espace de travail de cette clé API. Copiez l'ID depuis les paramètres WhatsApp.

Vérifier que l'API est disponible#

/api/v1/status/ est un simple contrôle de disponibilité. Il ne nécessite aucun identifiant, accepte n'importe quelle méthode et renvoie toujours :

{ "status": 200, "data": {} }

Il vous indique uniquement que l'API est joignable. Il ne vérifie ni vos identifiants ni la connexion de votre numéro WhatsApp.

curl https://wbiztool.com/api/v1/status/

La méthode health_check() du client Python appelle cet endpoint.

Conseils#

Vérifiez une seule fois lors de la configuration : appelez cet endpoint lorsqu'un utilisateur enregistre ses identifiants dans votre application, plutôt qu'avant chaque message. Une vérification réussie ne signifie pas que vous pouvez envoyer : elle ne contrôle ni vos crédits restants ni la connexion de votre numéro.
Lisez le corps en cas d'erreur : les échecs sont renvoyés avec le code HTTP 400 ou 403, assurez-vous donc que votre client HTTP analyse quand même le corps JSON.
Les clés supprimées cessent immédiatement de fonctionner : si une clé a été supprimée sur la page des clés API, vous obtiendrez Auth Error: invalid api key.
Étape suivante : une fois vos identifiants fonctionnels, envoyez un message.