Whatsplaid
Sprache und Währung
Kostenlos starten
Pläne
Auf der Website suchen
Sprache und Währung
Öffentliche API und Dokumentation

Verbinden Sie Ihre Systeme mit Whatsplaid über APIs, Connectors und Webhooks.

Verwenden Sie die öffentliche API, wenn ein anderes System Whatsplaid auslösen muss. Verwenden Sie den externen Connector, wenn der Assistent während der Unterhaltung Produkte, Bestellungen oder Daten aus Ihrem System abfragen muss. Verwenden Sie Webhooks, um Ereignisse zu empfangen, die auf WhatsApp erfasst wurden.

Drei Verträge

Wählen Sie die richtige Richtung der Integration.

Die Swagger-Dokumentation trennt die Abläufe, um Verwechslungen zwischen Aufrufen an Whatsplaid, Anfragen des Assistenten und an Ihr System gesendeten Ereignissen zu vermeiden.

01 Public API

Ihr System ruft Whatsplaid auf, um Konten zu validieren, Kontakte, Tags, Felder, Konversationen, Warenkorb, Nachrichten und menschlichen Support zu verwalten.

02 Custom Data Connector

Whatsplaid ruft Ihr System auf, um während eines Gesprächs Produkte, Bestellungen, Kunden oder die Echtzeitverfügbarkeit abzufragen.

03 Outgoing Webhooks

Whatsplaid sendet Ereignisse an eine von Ihnen angegebene URL. Das im Dashboard verfügbare Ereignis ist der während des Gesprächs erfasste Lead.

04 Dokumentation

Der Swagger unter `api.whatsplaid.com/docs/` enthält die Schemata, Beispiele, erwarteten Antworten und vollständigen technischen Verträge.

Kurzübersicht der wichtigsten Endpunkte.

Diese Ansicht fasst die Funktionen zusammen, die in der offiziellen Dokumentation erscheinen. Die endgültige Implementierung muss dem Swagger folgen.

GET /store

Gibt Kontodaten, verbundenen E‑Commerce und aktive Module zurück.

Account
GET /modules

Liste aktiver Module, wie Leads, Verkaufsberater, After-Sales, Wissensdatenbank und Warenkorb.

Account
GET /ecommerce/products/search

Suche nach Produkten in verbundenen nativen Integrationen, wie Nuvemshop, Wix oder Shopify.

Ecommerce
GET /ecommerce/orders/search

Bestellungen nach Nummer, E‑Mail oder Telefonnummer in den verbundenen nativen Integrationen suchen.

Ecommerce
POST /contacts

Erstellt oder aktualisiert einen Kontakt und verwendet die Telefonnummer als Primärschlüssel.

Contacts
PATCH /contacts/{contactId}/custom-fields

Aktualisiert benutzerdefinierte Felder für Targeting und operativen Kontext.

Fields
POST /messages/send

Sendet eine Textnachricht innerhalb des 24‑Stunden‑Antwortfensters von WhatsApp.

Messaging
POST /handoffs

Menschlichen Support anfordern unter Verwendung der aktuellen Unternehmenseinstellung.

Handoff
Technische Verträge

Die Dokumentation behandelt die API, den externen Connector und Webhooks.

Das Integrationsmenü des ADMIN verwendet dieselbe Trennung: Whatsplaid Public API, externer Connector für Abfragen in internen Systemen und ausgehender Webhook für erfasste Leads.

API pública

Validiert Konto, Module, Kontakte, Tags, benutzerdefinierte Felder, Nachrichten, Konversationen, Warenkorb und menschlichen Support.

Externer Connector

Ihr System stellt Endpunkte wie `/products/search` und `/orders/search` bereit, die Whatsplaid während des Gesprächs abfragen kann.

Produkte

Erwartete Rückgabe mit `products`, einschließlich ID, Name, Beschreibung, Preis, Verfügbarkeit, Lagerbestand, URL und Bild.

Bestellungen

Erwartete Antwort mit `orders`, inklusive Nummer, Status, Zahlung, Versand, Gesamt, Kunde, Sendungsverfolgung und Artikel.

Webhooks

Das Ereignis `LEAD_CAPTURE` sendet Lead-Daten an die konfigurierte URL. Der Endpunkt muss mit HTTP 200 oder 204 antworten.

Sicherheit

Verwenden Sie `Authorization: Bearer` bei Aufrufen. Tokens dürfen im öffentlichen Frontend nicht offengelegt werden.

Müssen Sie eine Integration implementieren oder validieren?

Öffnen Sie die interaktive Dokumentation, um zwischen `Whatsplaid Public API`, `Custom Data Connector Contract` und `Outgoing Webhooks` zu wechseln.

Swagger öffnen