Primi passi

API Verifica credenziali

Usa questa API per convalidare le tue credenziali prima di effettuare altre chiamate API. Conferma che client_id e api_key funzionano insieme e, facoltativamente, che l'ID di un numero WhatsApp appartiene al tuo spazio di lavoro. Non invia nulla e non consuma crediti.

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

Corpo: JSON o campi di un modulo

Esempio rapido#

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

Sostituisci 12345, YOUR_API_KEY e 678 con i tuoi valori. Ometti whatsapp_client se vuoi testare solo la chiave. Consulta Autenticazione per sapere dove trovarli.

Parametri della richiesta#

client_idintegerobbligatorio: Il tuo ID Client API, da Impostazioni → Chiavi API.
api_keystringobbligatorio: La tua chiave API, dalla stessa pagina.
whatsapp_clientintegerfacoltativo: ID di uno dei tuoi numeri WhatsApp, dalle Impostazioni WhatsApp. Invialo per verificare anche che l'ID appartenga allo spazio di lavoro di questa chiave API. Anche un numero che hai eliminato dalla dashboard supera questo controllo. Controlla solo l'ID: non ti dice se il numero è collegato. Per questo usa Stato della connessione.

Risposta#

Una richiesta riuscita restituisce HTTP 200:

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

Campo	Tipo	Descrizione
`status`	integer	`1` se le credenziali sono valide, `0` in caso contrario.
`message`	string	`Okay` in caso di successo, altrimenti l'errore.
`name`	string	Il nome utente della persona che ha creato lo spazio di lavoro. Se hai inviato `whatsapp_client`, il telefono del numero viene aggiunto dopo `-`. Presente solo in caso di successo.

Errori#

Ogni errore di questo endpoint restituisce HTTP 400, tranne un client_id non numerico, che restituisce HTTP 403. Il corpo ha sempre status impostato su 0:

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

Messaggio	Come risolvere
`Auth Error`	Invia sia `client_id` sia `api_key` nel corpo di una richiesta `POST`, come JSON valido o campi di un modulo. Questo messaggio compare anche quando `whatsapp_client` non è un numero.
`Invalid Client Id`	Invia `client_id` come numero intero, ad esempio `12345`.
`Auth Error: invalid api key`	Verifica che la chiave esista, non sia stata eliminata e appartenga a questo `client_id`.
`Invalid WhatsApp Client ID`	Quell'ID `whatsapp_client` non è nello spazio di lavoro di questa chiave API. Copia l'ID dalle Impostazioni WhatsApp.

Verificare che l'API sia attiva#

/api/v1/status/ è un semplice controllo di disponibilità. Non richiede credenziali, accetta qualsiasi metodo e restituisce sempre:

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

Ti dice solo che l'API è raggiungibile. Non controlla le tue credenziali né se il tuo numero WhatsApp è collegato.

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

Il metodo health_check() del client Python chiama questo endpoint.

Suggerimenti#

Verifica una volta in fase di configurazione: chiama questo endpoint quando un utente salva le proprie credenziali nella tua app, anziché prima di ogni messaggio. Una verifica riuscita non significa che puoi inviare: non controlla i crediti rimanenti né se il tuo numero è collegato.
Leggi il corpo in caso di errore: gli errori arrivano con HTTP 400 o 403, quindi assicurati che il tuo client HTTP analizzi comunque il corpo JSON.
Le chiavi eliminate smettono di funzionare immediatamente: se una chiave è stata eliminata nella pagina delle chiavi API, riceverai Auth Error: invalid api key.
Passo successivo: quando le credenziali funzionano, invia un messaggio.