Primeiros passos

API para verificar credenciais

Use esta API para validar suas credenciais antes de fazer outras chamadas à API. Ela confirma que seu client_id e sua api_key funcionam juntos e, opcionalmente, que um ID de número de WhatsApp pertence ao seu espaço de trabalho. Ela não envia nada e não consome créditos.

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

Corpo: JSON ou campos de formulário

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

Substitua 12345, YOUR_API_KEY e 678 pelos seus próprios valores. Omita whatsapp_client se quiser testar apenas a chave. Veja em Autenticação onde encontrá-los.

Parâmetros da requisição#

client_idintegerobrigatório: Seu ID do Cliente da API, em Configurações → Chaves API.
api_keystringobrigatório: Sua chave de API, na mesma página.
whatsapp_clientintegeropcional: ID de um dos seus números de WhatsApp, nas configurações do WhatsApp. Envie-o para verificar também se o ID pertence ao espaço de trabalho desta chave de API. Um número que você excluiu no painel ainda passa nesta verificação. Ele só verifica o ID; não informa se o número está conectado. Para isso, use Status da conexão.

Resposta#

Uma requisição bem-sucedida retorna HTTP 200:

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

Campo	Tipo	Descrição
`status`	integer	`1` se as credenciais forem válidas, `0` caso contrário.
`message`	string	`Okay` em caso de sucesso; caso contrário, o erro.
`name`	string	O nome de usuário da pessoa que criou o espaço de trabalho. Se você enviou `whatsapp_client`, o telefone do número é adicionado depois de `-`. Presente apenas em caso de sucesso.

Erros#

Toda falha neste endpoint retorna HTTP 400, exceto um client_id não numérico, que retorna HTTP 403. O corpo sempre tem status igual a 0:

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

Mensagem	Como corrigir
`Auth Error`	Envie `client_id` e `api_key` no corpo de um `POST`, como JSON válido ou campos de formulário. Esta mensagem também aparece quando `whatsapp_client` não é um número.
`Invalid Client Id`	Envie `client_id` como um número inteiro, por exemplo `12345`.
`Auth Error: invalid api key`	Verifique se a chave existe, não foi excluída e pertence a este `client_id`.
`Invalid WhatsApp Client ID`	Esse ID de `whatsapp_client` não está no espaço de trabalho desta chave de API. Copie o ID nas configurações do WhatsApp.

Verificar se a API está no ar#

/api/v1/status/ é uma verificação simples de disponibilidade. Não precisa de credenciais, aceita qualquer método e sempre retorna:

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

Ele só informa que a API está acessível. Não verifica suas credenciais nem se o seu número de WhatsApp está conectado.

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

O health_check() do cliente Python chama este endpoint.

Dicas#

Verifique uma vez na configuração: chame este endpoint quando um usuário salvar as credenciais no seu app, em vez de antes de cada mensagem. Uma verificação bem-sucedida não significa que você pode enviar: ela não confere os créditos restantes nem se o seu número está conectado.
Leia o corpo em caso de erro: as falhas voltam como HTTP 400 ou 403, então garanta que seu cliente HTTP continue interpretando o corpo JSON.
Chaves excluídas param de funcionar imediatamente: se uma chave foi excluída na página de chaves de API, você receberá Auth Error: invalid api key.
Próximo passo: quando suas credenciais funcionarem, envie uma mensagem.