⌘ FÜR ENTWICKLER

Eine Plattform. Drei starke Schnittstellen.

Rufen Sie Konversationen über die REST API ab, empfangen Sie Ereignisse in Echtzeit über HMAC-signierte Webhooks und steuern Sie die Chat-Blase auf Ihrer Website programmatisch mit der Widget JS API.

200 OK · 42 ms HMAC-SHA256-signierte Webhooks Zugriff per API-Schlüssel
01 · Erste Schritte

Ihre erste Anfrage in 5 Minuten

Für jede Schnittstelle gibt es eine Voraussetzung: Erstellen Sie auf der Seite Entwickler Ihres Dashboards einen API-Schlüssel. Damit können Sie Daten per REST abrufen, Webhooks einrichten und das Widget steuern.

1
Schlüssel erstellen
Dashboard → Entwickler → Neuer Schlüssel
2
Anfrage senden
Mit einem Authorization: Bearer-Header
3
Ereignisse empfangen
Webhook-URL festlegen
02 · Authentifizierung

Authentifizierung mit einem Bearer-Schlüssel

Fügen Sie Ihren Schlüssel jeder REST-Anfrage im Header Authorization hinzu. Schlüssel beginnen mit dem Präfix rc_live_ und werden nur einmal bei der Erstellung angezeigt – bewahren Sie Ihren sicher auf.

curl
curl https://revochat.app/api/v1/conversations \
  -H "Authorization: Bearer rc_live_XXXXXXXXXXXX"
03 · REST API

Programmatischer Zugriff auf Ihre Daten

Basis-URL: https://revochat.app/api/v1

GET/conversations

Listet Konversationen auf, zuletzt aktualisierte zuerst. Parameter: status (open | closed), limit (Standard 50, max. 200). Die Antwort liefert ein data-Array; jeder Datensatz enthält Website, Besucher, zugewiesenen Agenten, Tags, CSAT-Wert und Zeitstempel.

curl
curl "https://revochat.app/api/v1/conversations?status=open&limit=20" \
  -H "Authorization: Bearer rc_live_..."
GET/conversations/:id

Gibt eine einzelne Konversation mit allen Nachrichten zurück (ohne interne Notizen). Nachrichten enthalten sender, content, type und, falls vorhanden, Dateifelder. Gibt 404 zurück, wenn nichts gefunden wird.

Ein ungültiger oder fehlender Schlüssel erhält 401 mit dem Body { "error": "..." }. Ältere Schlüssel mit dem Präfix cd_live_ funktionieren weiterhin.

04 · Webhooks

Ereignisse in Ihren Händen, sobald sie eintreten

Legen Sie in Ihrem Dashboard eine Webhook-URL fest; die gewählten Ereignisse werden in dem Moment, in dem sie eintreten, als POST mit JSON-Body gesendet. Jede Anfrage enthält zwei Header: X-RevoChat-Event (der Ereignisname) und X-RevoChat-Signature (eine HMAC-SHA256-Signatur des Roh-Bodys, erstellt mit Ihrem Webhook-Secret) – prüfen Sie diese vor der Verarbeitung. Aufbau des Bodys: { event, createdAt, data }. Zustellungen brechen nach 5 Sekunden ab, antworten Sie also zügig.

conversation.created
Eine neue Konversation hat begonnen
message.created
Eine neue Nachricht ist eingegangen
conversation.closed
Eine Konversation wurde geschlossen
conversation.rated
Ein Besucher hat eine CSAT-Bewertung abgegeben
node — Signaturprüfung
const crypto = require("crypto");
const expected = crypto
  .createHmac("sha256", process.env.WEBHOOK_SECRET)
  .update(rawBody) // Roh-Body — VOR JSON.parse
  .digest("hex");
if (expected !== req.headers["x-revochat-signature"]) return res.status(401).end();
05 · Widget JS API

Volle Kontrolle über die Chat-Blase

Sobald das Installationsskript geladen ist, steht das Objekt window.RevoChat bereit:

widget.js
RevoChat.open();                    // Panel öffnen
RevoChat.close();                   // Panel schließen
RevoChat.toggle();                  // öffnen/schließen
RevoChat.isOpen();                  // geöffnet? (boolean)

RevoChat.identify({                 // Besucher identifizieren
  name: "Jane Doe",
  email: "[email protected]",
});

RevoChat.on("ready", () => {});     // Widget geladen
RevoChat.on("open", () => {});      // Panel geöffnet
RevoChat.on("close", () => {});     // Panel geschlossen
RevoChat.on("message", (m) => {});  // neue Nachricht ({ sender, content, type })

Fügen Sie dem Script-Tag data-lang="en" hinzu, um die Widget-Sprache pro Seite festzulegen (tr / en / de / es). Das Attribut data-canli-destek aus älteren Einbettungscodes wird weiterhin unterstützt.

06 · Verkaufs-Tracking

Chats mit Umsatz verknüpfen

Fügen Sie Ihrer Bestellbestätigungsseite eine Zeile hinzu; der Verkauf wird mit der letzten Konversation des Besuchers verknüpft und in den Analysen als „Chat-bezogener Umsatz“ ausgewiesen.

widget.js
RevoChat.track("purchase", {
  orderId: "ORD-1042",   // optional
  amount: 1299.9,        // erforderlich (Zahl)
  currency: "USD",       // Standard: TRY
});

Derzeit wird nur das Ereignis purchase unterstützt; der Verkauf wird der jüngsten Konversation des Besuchers zugerechnet.

Schlüssel holen, in 5 Minuten verbunden

API-Schlüssel und Webhook-Secrets verwalten Sie auf der Seite Entwickler in Ihrem Dashboard.

Zu den Entwicklern →
200 OK · 42 ms