Whatsplaid
Pläne
Auf der Website suchen
Öffentliche API und Dokumentation

Verbinden Sie eigene Systeme mit Whatsplaid über API, Konnektoren und Webhooks.

Verwenden Sie die öffentliche API, wenn ein anderes System Whatsplaid auslösen muss. Verwenden Sie den externen Konnektor, wenn der Assistent Produkte, Bestellungen oder Daten Ihres Systems während des Gesprächs abfragen muss. Verwenden Sie Webhooks, um Ereignisse zu empfangen, die im WhatsApp erfasst wurden.

Drei Verträge

Wählen Sie die richtige Richtung der Integration.

Die Swagger-Dokumentation trennt die Flüsse, um Verwirrung zwischen Anrufen an Whatsplaid, Abfragen durch den Assistenten und Ereignissen, die an Ihr System gesendet werden, zu vermeiden.

01 Public API

Ihr System ruft Whatsplaid auf, um Konten zu validieren, Kontakte, Tags, Felder, Gespräche, Warenkörbe, Nachrichten und menschlichen Support zu verwalten.

02 Custom Data Connector

Whatsplaid ruft Ihr System an, um Produkte, Bestellungen, Kunden oder Verfügbarkeit in Echtzeit während eines Gesprächs 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

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

Kurze Referenz der wichtigsten Endpunkte.

Diese Übersicht fasst die Ressourcen zusammen, die in der offiziellen Dokumentation erscheinen. Die endgültige Implementierung sollte dem Swagger folgen.

GET /store

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

Account
GET /modules

Liste der aktiven Module, wie Leads, Vertriebsberater, Nachverkauf, Wissensdatenbank und Warenkorb.

Account
GET /ecommerce/products/search

Produktsuche in verbundenen nativen Integrationen wie Nuvemshop, Wix oder Shopify.

Ecommerce
GET /ecommerce/orders/search

Suche nach Bestellungen anhand Nummer, E-Mail oder Telefon in verbundenen nativen Integrationen.

Ecommerce
POST /contacts

Erstellt oder aktualisiert Kontakt unter Verwendung der Telefonnummer als Hauptschlüssel.

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

Aktualisiert benutzerdefinierte Felder für Segmentierung und operativen Kontext.

Fields
POST /messages/send

Sendet eine Textnachricht innerhalb des 24-Stunden-Kundenservicefensters von WhatsApp.

Messaging
POST /handoffs

Fordert menschlichen Support unter Verwendung der aktuellen Unternehmenseinstellung an.

Handoff
Technische Verträge

Die Dokumentation umfasst API, externen Konnektor und Webhooks.

Das Integrationsmenü des ADMIN verwendet die gleiche Trennung: öffentliche Whatsplaid-API, externer Konnektor für Abfragen in eigenen Systemen und ausgehender Webhook für erfasste Leads.

API pública

Validiert Konto, Module, Kontakte, Tags, benutzerdefinierte Felder, Nachrichten, Gespräche, Warenkorb und menschlichen Support.

Externer Konnektor

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 Rückgabe mit `orders`, einschließlich Nummer, Status, Zahlung, Lieferung, Gesamtbetrag, Kunde, Sendungsverfolgung und Artikel.

Webhooks

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

Sicherheit

Verwenden Sie `Authorization: Bearer` bei den Aufrufen. Tokens sollten nicht im öffentlichen Frontend 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