API awam dan dokumentasi

Sambungkan sistem anda sendiri ke Whatsplaid dengan API, penyambung dan webhooks.

Gunakan API awam apabila sistem lain perlu mengaktifkan Whatsplaid. Gunakan penyambung luaran apabila pembantu perlu menyemak produk, pesanan atau data sistem anda semasa perbualan. Gunakan webhooks untuk menerima acara yang ditangkap di WhatsApp.

Buka dokumentasi Lihat integrasi

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."
}

Tiga kontrak

Pilih arah yang betul untuk integrasi.

Dokumentasi Swagger memisahkan aliran untuk mengelakkan kekeliruan antara panggilan ke Whatsplaid, pertanyaan yang dibuat oleh pembantu dan acara yang dihantar ke sistem anda.

01 Public API

Sistem anda memanggil Whatsplaid untuk mengesahkan akaun, mengurus kenalan, tag, medan, perbualan, troli, mesej dan perkhidmatan manusia.

02 Custom Data Connector

Whatsplaid memanggil sistem anda untuk menyemak produk, pesanan, pelanggan atau ketersediaan secara masa nyata semasa perbualan.

03 Outgoing Webhooks

Whatsplaid menghantar acara ke URL anda. Acara yang tersedia di panel adalah lead yang ditangkap semasa perbualan.

04 Dokumentasi

Swagger di `api.whatsplaid.com/docs/` mengandungi skema, contoh, jawapan yang dijangka dan kontrak teknikal lengkap.

Rujukan pantas bagi endpoint utama.

Pandangan ini merangkumkan ciri yang muncul dalam dokumentasi rasmi. Pelaksanaan akhir harus mengikuti Swagger.

GET /store

Mengembalikan data akaun, e-dagang yang disambungkan dan modul aktif.

Account

GET /modules

Senarai modul aktif, seperti leads, perunding jualan, selepas jualan, pangkalan pengetahuan dan troli.

Account

GET /ecommerce/products/search

Cari produk dalam integrasi asli yang disambungkan, seperti Nuvemshop, Wix atau Shopify.

Ecommerce

GET /ecommerce/orders/search

Cari pesanan berdasarkan nombor, e-mel atau telefon dalam integrasi asli yang disambungkan.

Ecommerce

POST /contacts

Cipta atau kemas kini kenalan menggunakan telefon sebagai kunci utama.

Contacts

PATCH /contacts/{contactId}/custom-fields

Kemas kini medan tersuai untuk penskalaan dan konteks operasi.

Fields

POST /messages/send

Hantar mesej teks dalam tetingkap perkhidmatan WhatsApp selama 24 jam.

Messaging

POST /handoffs

Meminta perkhidmatan manusia menggunakan tetapan semasa syarikat.

Handoff

Kontrak teknikal

Dokumentasi merangkumi API, penyambung luar dan webhook.

Menu integrasi ADMIN menggunakan pemisahan yang sama: API awam Whatsplaid, penyambung luar untuk pertanyaan dalam sistem sendiri dan webhook keluar untuk leads yang ditangkap.

API pública

Sahkan akaun, modul, kenalan, tag, medan tersuai, mesej, perbualan, troli dan perkhidmatan manusia.

Penyambung luar

Sistem anda mengekspos titik akhir seperti `/products/search` dan `/orders/search` untuk Whatsplaid rujuk semasa perbualan.

Produk

Jangkaan maklum balas dengan `products`, termasuk ID, nama, penerangan, harga, ketersediaan, stok, URL dan imej.

Pesanan

Jangkaan maklum balas dengan `orders`, termasuk nombor, status, pembayaran, penghantaran, jumlah, pelanggan, penjejakan dan item.

Webhook

Peristiwa `LEAD_CAPTURE` menghantar data lead ke URL yang dikonfigurasi. Titik akhir harus menjawab HTTP 200 atau 204.

Keselamatan

Gunakan `Authorization: Bearer` dalam panggilan. Token tidak boleh didedahkan di frontend awam.

Perlu melaksanakan atau mengesahkan integrasi?

Buka dokumentasi interaktif untuk beralih antara `Whatsplaid Public API`, `Custom Data Connector Contract` dan `Outgoing Webhooks`.

Buka Swagger