API-Schlüssel
Aktualisiert am
Wo: Einstellungen > Integrationen > API-Schlüssel
Wofür es gedacht ist:
"Geben Sie einem externen Programm einen eigenen Schlüssel zum Senden über SyBox — der WhatsApp-Token verlässt niemals den Server, und ein kompromittierter Schlüssel kann isoliert widerrufen werden." Ihr ERP, Kassensystem oder Desktopprogramm nutzt einen SyBox-Schlüssel. Es benötigt niemals Ihre echten WhatsApp-Zugangsdaten.
Was ein Programm mit einem Schlüssel tun kann (beschrieben auf der öffentlichen Entwicklerdokumentationsseite):
- WhatsApp-Nachrichten über Ihre eigene verknüpfte Nummer senden. Es verwendet dasselbe Anfrageformat wie Metas WhatsApp Cloud-API. Ein dafür geschriebenes Programm benötigt daher nur eine neue Adresse und einen SyBox-Schlüssel. Text, Vorlagen, Bilder, Dokumente und interaktive Nachrichten funktionieren gleichermaßen. Antworten und Fehler werden exakt so zurückgegeben, wie Meta sie ausgibt.
- Einen Fall aus Ihrem eigenen System anlegen, zum Beispiel eine in Ihrem ERP erfasste Reklamation. Der Kunde muss bereits in SyBox existieren.
- SMS von einem Telefon in den Posteingang importieren.
Wer Zugriff hat: der Hauptadministrator und Teammitglieder mit der Berechtigung "WhatsApp-Nummern verwalten".
Der Schalter "API-Gateway":
Oben in der API-Schlüssel-Ansicht befindet sich der Schalter "API-Gateway". Er ist standardmäßig deaktiviert. Solange er aus ist, funktioniert kein Schlüssel und Sie können keine neuen Schlüssel erstellen. Bei einem Versuch erscheint: "Das API-Gateway ist deaktiviert. Schalten Sie es über den Schalter oben auf dieser Seite ein, bevor Sie Schlüssel erstellen." Der Schalter wird beim Anklicken sofort gespeichert.
- Gehen Sie zu Einstellungen > Integrationen > API-Schlüssel.
- Schalten Sie den Schalter "API-Gateway" ein.
- Klicken Sie auf "Neuer Schlüssel".
- Wählen Sie den "Schlüsseltyp":
- "Über WhatsApp senden": Das Programm sendet Nachrichten an Ihre Kunden.
- "Fall anlegen": Das Programm öffnet Fälle in SyBox. Es kann keine Nachrichten senden.
- "SMS von einem Telefon importieren": Ein Smartphone leitet seine SMS-Nachrichten in den Posteingang weiter.
- Füllen Sie "Geräte- oder Programmname" aus, zum Beispiel "Büro-PC" oder "Buchhaltungssystem". Vergeben Sie für jedes Gerät oder Programm einen eigenen Schlüssel.
- Für einen Schlüssel vom Typ "Über WhatsApp senden" legen Sie außerdem fest:
- "Sendet von": die WhatsApp-Nummer, von der dieser Schlüssel sendet (erforderlich).
- "Freitextnachrichten erlauben": an oder aus.
- "Genehmigte Vorlagen erlauben": an oder aus. Mindestens eine dieser beiden Optionen muss aktiv sein, andernfalls erscheint: "Erlauben Sie mindestens Freitext oder Vorlagen — andernfalls kann der Schlüssel nichts senden."
- "Senden von Medien erlauben": an oder aus.
- "Vorlagen" (optional): Vorlagennamen, getrennt durch Kommas. Leer lassen, um alle Vorlagen zu erlauben.
- "Erlaubte Empfängerländer" (optional): zweistellige Ländercodes, z. B. MA,FR,EG. Leer lassen, um jedes Land zu erlauben.
- "Senden erlaubt von" ... "Zu": das Zeitfenster, in dem der Schlüssel senden darf. Lassen Sie beide Zeiten identisch für unbegrenzte Sendezeiten. Die Zeiten beziehen sich auf die Ortszeit des Arbeitsbereichs.
- "Tägliches Nachrichtenlimit (0 = unbegrenzt)".
- Für einen Schlüssel vom Typ "SMS von einem Telefon importieren" aktivieren Sie "Nur Kontakte und Kunden". Wenn dies aktiv ist, verbleibt eine SMS von jeder anderen Nummer auf dem Telefon und gelangt nicht in den Posteingang. Deaktivieren Sie dies nur, wenn das Telefon ausschließlich beruflich genutzt wird.
- Klicken Sie auf Speichern.
- Ein Fenster zeigt die "Basis-URL" und den "API-Schlüssel". Kopieren Sie diese jetzt. "Kopieren Sie diesen Schlüssel jetzt — er wird nur einmal angezeigt." Hinterlegen Sie sie in den Einstellungen Ihres Programms.
Was die Schlüsselkarte anzeigt:
- Den Namen des Schlüssels und die Absendernummer (oder die Typ-Kennzeichnung bei Schlüsseln, die nicht senden).
- Die letzten Zeichen des Schlüssels zur einfachen Unterscheidung.
- "zuletzt verwendet", mit Datum und Uhrzeit, oder "nie".
- Alle aktiven Einschränkungen: "Nur Freitext", "Nur Vorlagen", "keine Medien", "Vorlagen", erlaubte Länder, Sendezeiten und das Tageslimit im Format heute gesendet / Limit / Tag. Ein SMS-Schlüssel für beliebige Absender zeigt "Jede Nummer".
- Klicken Sie auf der Karte des Schlüssels auf Bearbeiten. Sie können Name, Nummer und Limits anpassen. Der Schlüsseltyp kann nach der Erstellung nicht mehr geändert werden, und der Schlüssel selbst wird nie wieder angezeigt.
- Klicken Sie auf Aktivieren / Deaktivieren, um einen Schlüssel vorübergehend anzuhalten.
- Klicken Sie auf Löschen und bestätigen Sie: "Diesen API-Schlüssel löschen? Jedes Programm, das ihn noch verwendet, funktioniert sofort nicht mehr."
Ich habe meinen API-Schlüssel verloren. Kann ich ihn noch einmal sehen?
Nein. Er wird nur ein einziges Mal angezeigt. Erstellen Sie einen neuen Schlüssel, tragen Sie ihn in Ihr Programm ein und löschen Sie den alten.
Ich befürchte, ein Schlüssel wurde kompromittiert. Was soll ich tun?
Löschen oder deaktivieren Sie diesen Schlüssel unverzüglich. Nur dieser Schlüssel verliert seine Gültigkeit. Ihre WhatsApp-Nummer und Ihre übrigen Schlüssel bleiben unberührt.
Die Liste "Sendet von" ist leer.
Die Liste führt nur WhatsApp-Nummern auf, die verknüpft und eingeschaltet sind. Verbinden Sie zuerst eine Nummer unter Einstellungen > Messaging > Kanäle.
Mein Programm wird beim Senden abgewiesen.
Prüfen Sie, ob das "API-Gateway" eingeschaltet und der Schlüssel aktiv ist. Prüfen Sie auch die Einschränkungen des Schlüssels: Freitext vs. Vorlagen, Medien, erlaubte Vorlagen, Länder, Sendezeiten und das Tageslimit. Zudem gelten weiterhin die Richtlinien von WhatsApp. Freitext funktioniert beispielsweise nur innerhalb von 24 Stunden nach der letzten Nachricht des Kunden.
Kann ein Schlüssel vom Typ "Fall anlegen" auch Nachrichten senden?
Nein, das ist bewusst so geregelt. Ein Schlüssel zur Fallerstellung kann Kunden keine Nachrichten schreiben, und ein Sendeschlüssel kann keine Fälle anlegen. Verwenden Sie für jede Aufgabe einen separaten Schlüssel.
Ich habe noch einen alten Schlüssel vom Typ "Von einem Programm empfangen". Funktioniert dieser weiterhin?
Ja, bestehende Schlüssel dieses Typs bleiben funktionsfähig. Neue Schlüssel dieses Typs können jedoch nicht mehr erstellt werden. Verwenden Sie dafür künftig "Fall anlegen".