Produktanleitungen

API-Schlüssel

Um die Wbiztool-API oder eine Integration zu nutzen, die nach Ihren Zugangsdaten fragt, benötigen Sie drei Angaben aus dem Dashboard:

Zugangsdaten	API-Feld	Wo Sie sie finden
API-Client-ID	`client_id`	Einstellungen → API-Schlüssel, oben auf der Seite
API-Schlüssel	`api_key`	Einstellungen → API-Schlüssel
WhatsApp-Client-ID	`whatsapp_client`	Die Spalte WhatsApp-Client-ID in den WhatsApp-Einstellungen

Bevor Sie beginnen#

Sie müssen Administrator des Arbeitsbereichs sein, um API-Schlüssel zu sehen, zu erstellen oder zu löschen. Siehe Rollen und Berechtigungen.
Wählen Sie zuerst den richtigen Arbeitsbereich aus. Schlüssel gehören zu dem Arbeitsbereich, der beim Erstellen ausgewählt ist, und API-Anfragen mit einem Schlüssel wirken auf diesen Arbeitsbereich. Siehe Arbeitsbereich wechseln.
Demo-Konten können die API nicht nutzen.

API-Client-ID finden#

Öffnen Sie Einstellungen → API-Schlüssel. Die Karte API-Übersicht zeigt API-Client-ID: gefolgt von einer Zahl. Verwenden Sie diese Zahl in jeder Anfrage als client_id. Sie ist für jeden Schlüssel im Arbeitsbereich gleich.

API-Schlüssel erstellen#

API-Schlüssel öffnen
Gehen Sie zu Einstellungen und klicken Sie auf den Tab API-Schlüssel, oder öffnen Sie direkt /settings/#api-keys.
Schlüssel erstellen
Klicken Sie unter Neuer API-Schlüssel auf Neu erstellen. Eine Erfolgsmeldung bestätigt, dass der Schlüssel generiert wurde, und er erscheint in der Tabelle.
Vollständigen Schlüssel kopieren
Die Spalte API-Schlüssel zeigt nur Anfang und Ende jedes Schlüssels. Klicken Sie auf die Kopier-Schaltfläche daneben (Vollständigen API-Schlüssel kopieren), um den vollständigen Schlüssel zu kopieren, und fügen Sie ihn dann in Ihre App oder Integration ein.

Schlüssel werden automatisch anhand der Anzahl der Schlüssel im Arbeitsbereich benannt (API Key 1, API Key 2 und so weiter) und können nicht umbenannt werden. Nachdem Sie einen Schlüssel gelöscht haben, kann ein neuer Schlüssel denselben Namen wie ein vorhandener erhalten. Unterscheiden Sie Schlüssel daher anhand ihrer ersten und letzten Zeichen und des Datums unter Erstellt. Schlüssel laufen nicht ab: Ein Schlüssel funktioniert, bis Sie ihn löschen.

Limit#

Ein Arbeitsbereich kann gleichzeitig bis zu 10 API-Schlüssel haben. Wenn Sie das Limit erreichen, sehen Sie „You have reached the maximum limit of 10 API keys per organization.“ (Sie haben das Maximum von 10 API-Schlüsseln pro Organisation erreicht). Löschen Sie einen nicht mehr genutzten Schlüssel, um einen neuen zu erstellen.

Die Tabelle der API-Schlüssel#

Spalte	Bedeutung
Label	Der Name des Schlüssels, zum Beispiel API Key 1.
API-Schlüssel	Die ersten und letzten Zeichen des Schlüssels. Verwenden Sie für den vollständigen Schlüssel die Kopier-Schaltfläche.
Erstellt	Das Datum, an dem der Schlüssel erstellt wurde.
Status	Immer Aktiv. Gelöschte Schlüssel werden aus der Tabelle entfernt.
Aktionen	Löschen entfernt den Schlüssel.

API-Schlüssel löschen#

Schlüssel suchen
Suchen Sie den Schlüssel unter Einstellungen → API-Schlüssel in der Tabelle.
Schlüssel löschen
Klicken Sie auf Löschen und dann auf Ja, API-Schlüssel löschen.

Das Löschen eines Schlüssels kann nicht rückgängig gemacht werden. Jede App, die ihn noch verwendet, funktioniert sofort nicht mehr und erhält Auth Error: invalid api key. Aktualisieren Sie Ihre Apps zuerst mit einem neuen Schlüssel.

WhatsApp-Client-IDs#

Jede verbundene WhatsApp-Nummer hat eine eigene ID. Die meisten Messaging-Endpoints benötigen sie im Feld whatsapp_client, um festzulegen, welche Nummer die Nachricht sendet.

Öffnen Sie die WhatsApp-Einstellungen und lesen Sie die Spalte WhatsApp-Client-ID neben jeder Nummer ab. Siehe WhatsApp-Nummer verbinden, falls Sie noch keine verbunden haben.

Zugangsdaten testen#

Rufen Sie Zugangsdaten prüfen (POST /api/v1/me/) mit Ihrer client_id und Ihrem api_key auf, optional mit einem whatsapp_client. So wird bestätigt, dass die Angaben zusammen funktionieren, ohne dass etwas gesendet oder Nachrichten verbraucht werden. Gehört der whatsapp_client nicht zum Arbeitsbereich, lautet die Antwort Invalid WhatsApp Client ID.

Wenn ein API-Schlüssel offengelegt wurde#

Jeder, der Ihren API-Schlüssel und Ihre API-Client-ID hat, kann Nachrichten von Ihren WhatsApp-Nummern senden und die Nachrichten Ihres Arbeitsbereichs verbrauchen.

Ersatzschlüssel erstellen
Klicken Sie unter Einstellungen → API-Schlüssel auf Neu erstellen und kopieren Sie den neuen Schlüssel.
Apps aktualisieren
Ersetzen Sie den alten Schlüssel in jeder App und Integration, die ihn verwendet hat.
Offengelegten Schlüssel löschen
Klicken Sie beim offengelegten Schlüssel auf Löschen. Er funktioniert sofort nicht mehr.
Auf Missbrauch prüfen
Prüfen Sie die letzten Nachrichten unter Berichte auf Nachrichten, die Sie nicht gesendet haben.

Behandeln Sie auch die E-Mail „WbizTool Alert - WhatsApp Connected Successfully!“ vertraulich: Sie wird an den Ersteller des Arbeitsbereichs gesendet, wenn zum ersten Mal eine Nummer verbunden wird, und kann einen Ihrer API-Schlüssel enthalten.

Fehlerbehebung#

Problem	Was zu prüfen ist
Der Tab API-Schlüssel zeigt Keine API-Schlüssel gefunden, obwohl Schlüssel existieren	Sie sind in diesem Arbeitsbereich kein Administrator, oder ein anderer Arbeitsbereich ist ausgewählt.
„You don't have permission to create API keys in this space.“ (keine Berechtigung, in diesem Space API-Schlüssel zu erstellen)	Nur Administratoren können Schlüssel erstellen oder löschen. Die Schaltfläche Neuen API-Schlüssel generieren in einer leeren Tabelle wird allen angezeigt, funktioniert aber nur für Administratoren.
„You have reached the maximum limit of 10 API keys per organization.“	Löschen Sie einen nicht mehr genutzten Schlüssel.
`Auth Error: invalid api key`	Der Schlüssel wurde gelöscht oder falsch eingegeben, oder die `client_id` gehört nicht zum selben Arbeitsbereich wie der Schlüssel. Schlagen ein neuer Schlüssel und die auf der Seite angezeigte API-Client-ID trotzdem fehl, wenden Sie sich an den Support (ältere Arbeitsbereiche können eine API-Client-ID anzeigen, die nur mit Schlüsseln funktioniert, die der Ersteller des Arbeitsbereichs angelegt hat).
`Auth Error - Please send correct API key and Client id`	`api_key` fehlt im Request.
`Invalid client id.` (oder `Invalid Client Id` bei manchen Endpoints)	`client_id` fehlt oder ist keine Zahl. Bei Zugangsdaten prüfen liefert ein fehlendes `client_id` oder `api_key` nur `Auth Error`; `Invalid Client Id` bedeutet dort, dass der Wert keine Zahl ist. Kopieren Sie sie aus der Karte API-Übersicht.
Anfragen wirken auf den falschen Arbeitsbereich	Der Schlüssel wurde in einem anderen Arbeitsbereich erstellt. Wechseln Sie den Arbeitsbereich und erstellen Sie dort einen Schlüssel.
`Demo Account can not access apis`	Demo-Konten können die API nicht nutzen. Registrieren Sie sich für ein kostenloses Konto.