Openbare API en dokumentasie

Koppel jou eie stelsels aan Whatsplaid met API, koppelstukke en webhooks.

Gebruik die openbare API wanneer 'n ander stelsel Whatsplaid moet aktiveer. Gebruik die eksterne koppelstuk wanneer die assistent produkte, bestellings of data van jou stelsel tydens die gesprek moet opvraag. Gebruik webhooks om gebeurtenisse te ontvang wat in WhatsApp vasgevang word.

Open dokumentasie Sien integrasies

Base URL https://api.whatsplaid.com/v1

# autenticação
Authorization: Bearer {"{api_token}"}

# validar conta, módulos e integrações
GET /store

# enviar mensagem dentro da janela do WhatsApp
POST /messages/send
{
  "phone": "5511999999999",
  "text": "Seu atendimento foi atualizado."
}

Drie kontrakte

Kies die regte rigting van die integrasie.

Die Swagger-dokumentasie verdeel die vloei om verwarring tussen oproepe na Whatsplaid, opvrag deur die assistent en gebeurtenisse na jou stelsel te voorkom.

01 Public API

Jou stelsel roep Whatsplaid aan om rekening te verifieer, kontakte, etikette, velde, gesprekke, karretjie, boodskappe en menslike diens te bestuur.

02 Custom Data Connector

Whatsplaid roep jou stelsel aan om produkte, bestellings, kliënte of beskikbaarheid in reële tyd tydens 'n gesprek te raadpleeg.

03 Outgoing Webhooks

Whatsplaid stuur gebeurtenisse na jou URL. Die beskikbare gebeurtenis op die paneel is die leidraad wat tydens die gesprek vasgevang is.

04 Dokumentasie

Die Swagger in `api.whatsplaid.com/docs/` bevat die skemas, voorbeelde, verwagte antwoorde en volledige tegniese kontrakte.

Kort verwysing van die belangrikste eindpunte.

Hierdie oorsig som die funksies op wat in die amptelike dokumentasie voorkom. Die finale implementering moet die Swagger volg.

GET /store

Gee data van die rekening, gekoppelde e-commerce en aktiewe modules terug.

Account

GET /modules

Aktiewe modules lys, soos leidrade, verkoopsadviseur, ná-verkope, kennisbasis en karretjie.

Account

GET /ecommerce/products/search

Soek produkte in die ingeboude koppelvlakke soos Nuvemshop, Wix of Shopify.

Ecommerce

GET /ecommerce/orders/search

Soek bestellings op nommer, e-pos of telefoon in die ingeboude koppelvlakke.

Ecommerce

POST /contacts

Skep of werk kontak op met telefoon as hoofsleutel.

Contacts

PATCH /contacts/{contactId}/custom-fields

Werk pasgemaakte velde by vir segmentasie en operasionele konteks.

Fields

POST /messages/send

Stuur teksboodskap binne die 24-uur diensvenster van WhatsApp.

Messaging

POST /handoffs

Vra vir menslike diens met die huidige maatskappy se instellings.

Handoff

Tegniese kontrakte

Die dokumentasie dek API, eksterne konnektor en webhooks.

Die ADMIN-integraasiekieslys gebruik dieselfde skeiding: Whatsplaid se openbare API, eksterne konnektor vir navrae in eie stelsels en uitgaande webhook vir vasgelegde leidrade.

API pública

Valideer rekening, modules, kontakte, etikette, pasgemaakte velde, boodskappe, gesprekke, karretjie en menslike diens.

Eksterne Konnektor

Jou stelsel stel eindpunte uit soos `/products/search` en `/orders/search` vir Whatsplaid om tydens die gesprek te raadpleeg.

Produkte

Verwagte terugvoer met `products`, insluitend ID, naam, beskrywing, prys, beskikbaarheid, voorraad, URL en beeld.

Bestellings

Verwagte terugvoer met `orders`, insluitend nommer, status, betaling, aflewering, totaal, kliënt, spoor en items.

Webhooks

Die gebeurtenis `LEAD_CAPTURE` stuur leidraaddata na die gekonfigureerde URL. Die eindpunt moet HTTP 200 of 204 antwoord.

Sekuriteit

Gebruik `Authorization: Bearer` in die oproepe. Tokens mag nie in die openbare frontend blootgestel word nie.

Moet jy 'n integrasie implementeer of valideer?

Maak die interaktiewe dokumentasie oop om tussen `Whatsplaid Public API`, `Custom Data Connector Contract` en `Outgoing Webhooks` te wissel.

Open Swagger