Primeros pasos

API para comprobar credenciales

Usa esta API para validar tus credenciales antes de hacer otras llamadas a la API. Confirma que tu client_id y tu api_key funcionan juntos y, de forma opcional, que un ID de número de WhatsApp pertenece a tu espacio de trabajo. No envía nada ni consume créditos.

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

Cuerpo: JSON o campos de formulario

Ejemplo rápido#

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');
}

Sustituye 12345, YOUR_API_KEY y 678 por tus propios valores. Omite whatsapp_client si solo quieres probar la clave. Consulta Autenticación para saber dónde encontrarlos.

Parámetros de la solicitud#

client_idintegerobligatorio: Tu ID de cliente de la API, de Configuración → Claves API.
api_keystringobligatorio: Tu clave API, de esa misma página.
whatsapp_clientintegeropcional: ID de uno de tus números de WhatsApp, de la configuración de WhatsApp. Envíalo para comprobar además que el ID pertenece al espacio de trabajo de esta clave API. Un número que eliminaste del panel también pasa esta comprobación. Solo comprueba el ID; no te dice si el número está conectado. Para eso, usa Estado de conexión.

Respuesta#

Una solicitud correcta devuelve HTTP 200:

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

Campo	Tipo	Descripción
`status`	integer	`1` si las credenciales son válidas, `0` si no lo son.
`message`	string	`Okay` si todo va bien; en caso contrario, el error.
`name`	string	El nombre de usuario de la persona que creó el espacio de trabajo. Si enviaste `whatsapp_client`, el teléfono del número se añade después de `-`. Solo aparece si la solicitud es correcta.

Errores#

Todos los fallos de este endpoint devuelven HTTP 400, salvo un client_id no numérico, que devuelve HTTP 403. El cuerpo siempre tiene status con valor 0:

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

Mensaje	Cómo solucionarlo
`Auth Error`	Envía `client_id` y `api_key` en el cuerpo de una solicitud `POST`, como JSON válido o campos de formulario. Este mensaje también aparece cuando `whatsapp_client` no es un número.
`Invalid Client Id`	Envía `client_id` como número entero, por ejemplo `12345`.
`Auth Error: invalid api key`	Comprueba que la clave existe, que no se ha eliminado y que pertenece a este `client_id`.
`Invalid WhatsApp Client ID`	Ese ID de `whatsapp_client` no está en el espacio de trabajo de esta clave API. Copia el ID desde la configuración de WhatsApp.

Comprobar que la API está activa#

/api/v1/status/ es una comprobación simple de disponibilidad. No necesita credenciales, acepta cualquier método y siempre devuelve:

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

Solo te indica que la API es accesible. No comprueba tus credenciales ni si tu número de WhatsApp está conectado.

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

El método health_check() del cliente de Python llama a este endpoint.

Consejos#

Comprueba una sola vez durante la configuración: llama a este endpoint cuando un usuario guarde sus credenciales en tu app, en lugar de hacerlo antes de cada mensaje. Una comprobación correcta no significa que puedas enviar: no revisa tus créditos restantes ni si tu número está conectado.
Lee el cuerpo cuando haya errores: los fallos llegan como HTTP 400 o 403, así que asegúrate de que tu cliente HTTP siga procesando el cuerpo JSON.
Las claves eliminadas dejan de funcionar de inmediato: si una clave se eliminó en la página de claves API, recibirás Auth Error: invalid api key.
Siguiente paso: cuando tus credenciales funcionen, envía un mensaje.