Erste Schritte

Zugangsdaten prüfen (API)

Mit dieser API prüfen Sie Ihre Zugangsdaten, bevor Sie andere API-Aufrufe durchführen. Sie bestätigt, dass Ihre client_id und Ihr api_key zusammenpassen, und optional, dass eine WhatsApp-Nummern-ID zu Ihrem Arbeitsbereich gehört. Dabei wird nichts gesendet und es werden keine Credits verbraucht.

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

Body: JSON oder Formularfelder

Kurzes Beispiel#

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

Ersetzen Sie 12345, YOUR_API_KEY und 678 durch Ihre eigenen Werte. Lassen Sie whatsapp_client weg, wenn Sie nur den Schlüssel testen möchten. Wo Sie diese finden, steht unter Authentifizierung.

Request-Parameter#

client_idintegererforderlich: Ihre API-Client-ID aus Einstellungen → API-Schlüssel.
api_keystringerforderlich: Ihr API-Schlüssel von derselben Seite.
whatsapp_clientintegeroptional: ID einer Ihrer WhatsApp-Nummern aus den WhatsApp-Einstellungen. Senden Sie sie mit, um zusätzlich zu prüfen, ob die ID zum Arbeitsbereich dieses API-Schlüssels gehört. Eine Nummer, die Sie im Dashboard gelöscht haben, besteht diese Prüfung trotzdem. Es wird nur die ID geprüft; ob die Nummer verbunden ist, erfahren Sie hier nicht. Verwenden Sie dafür Verbindungsstatus.

Antwort#

Ein erfolgreicher Request gibt HTTP 200 zurück:

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

Feld	Typ	Beschreibung
`status`	integer	`1`, wenn die Zugangsdaten gültig sind, sonst `0`.
`message`	string	`Okay` bei Erfolg, andernfalls der Fehler.
`name`	string	Der Benutzername der Person, die den Arbeitsbereich erstellt hat. Wenn Sie `whatsapp_client` gesendet haben, wird die Telefonnummer dieser Nummer nach `-` angehängt. Nur bei Erfolg vorhanden.

Fehler#

Jeder Fehler auf diesem Endpoint gibt HTTP 400 zurück, außer bei einer nicht numerischen client_id, die HTTP 403 liefert. Der Body enthält immer status mit dem Wert 0:

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

Meldung	Lösung
`Auth Error`	Senden Sie `client_id` und `api_key` in einem `POST`-Body, als gültiges JSON oder als Formularfelder. Diese Meldung erscheint auch, wenn `whatsapp_client` keine Zahl ist.
`Invalid Client Id`	Senden Sie `client_id` als ganze Zahl, zum Beispiel `12345`.
`Auth Error: invalid api key`	Prüfen Sie, ob der Schlüssel existiert, nicht gelöscht wurde und zu dieser `client_id` gehört.
`Invalid WhatsApp Client ID`	Diese `whatsapp_client`-ID gehört nicht zum Arbeitsbereich dieses API-Schlüssels. Kopieren Sie die ID aus den WhatsApp-Einstellungen.

Prüfen, ob die API erreichbar ist#

/api/v1/status/ ist ein einfacher Verfügbarkeitscheck. Er benötigt keine Zugangsdaten, akzeptiert jede Methode und gibt immer Folgendes zurück:

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

Er zeigt nur, dass die API erreichbar ist. Ihre Zugangsdaten und die Verbindung Ihrer WhatsApp-Nummer werden dabei nicht geprüft.

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

health_check() im Python-Client ruft diesen Endpoint auf.

Tipps#

Einmal bei der Einrichtung prüfen: Rufen Sie diesen Endpoint auf, wenn ein Nutzer seine Zugangsdaten in Ihrer App speichert, und nicht vor jeder Nachricht. Eine erfolgreiche Prüfung bedeutet nicht, dass Sie senden können: Ihre verbleibenden Credits und der Verbindungsstatus Ihrer Nummer werden dabei nicht geprüft.
Bei Fehlern den Body lesen: Fehler kommen als HTTP 400 oder 403 zurück. Stellen Sie sicher, dass Ihr HTTP-Client den JSON-Body trotzdem auswertet.
Gelöschte Schlüssel funktionieren sofort nicht mehr: Wurde ein Schlüssel auf der Seite „API-Schlüssel“ gelöscht, erhalten Sie Auth Error: invalid api key.
Nächster Schritt: Sobald Ihre Zugangsdaten funktionieren, senden Sie eine Nachricht.