API awam dan dokumentasi

Sambungkan sistem anda ke Whatsplaid dengan API, penyambung dan webhook.

Gunakan API awam apabila sistem lain perlu mencetuskan Whatsplaid. Gunakan penyambung luaran apabila pembantu perlu memanggil produk, pesanan atau data dari sistem anda semasa perbualan. Gunakan webhook 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 integrasi yang betul.

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 sokongan manusia.

02 Custom Data Connector

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

03 Outgoing Webhooks

Whatsplaid menghantar acara ke URL yang anda berikan. Acara yang dipaparkan di papan pemuka ialah lead yang ditangkap semasa perbualan.

04 Dokumentasi

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

Rujukan pantas untuk endpoint utama.

Paparan ini merumuskan ciri-ciri yang muncul dalam dokumentasi rasmi. Pelaksanaan akhir mesti mengikut Swagger.

GET /store

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

Account

GET /modules

Senarai modul aktif, seperti leads, perunding jualan, khidmat 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 mengikut nombor, e-mel atau telefon dalam integrasi asli yang disambungkan.

Ecommerce

POST /contacts

Mewujudkan atau mengemas kini kenalan dengan menggunakan nombor telefon sebagai kunci utama.

Contacts

PATCH /contacts/{contactId}/custom-fields

Mengemas kini medan tersuai untuk penargetan dan konteks operasi.

Fields

POST /messages/send

Menghantar mesej teks dalam tetingkap pemesejan 24 jam WhatsApp.

Messaging

POST /handoffs

Minta sokongan manusia menggunakan konfigurasi syarikat semasa.

Handoff

Kontrak teknikal

Dokumentasi merangkumi API, penyambung luaran dan webhooks.

Menu integrasi ADMIN menggunakan pemisahan yang sama: Whatsplaid Public API, penyambung luaran untuk pertanyaan dalam sistem dalaman dan webhook keluar untuk lead yang ditangkap.

API pública

Mengesahkan akaun, modul, kenalan, tag, medan tersuai, mesej, perbualan, troli dan sokongan manusia.

Penyambung luaran

Sistem anda mendedahkan titik akhir seperti `/products/search` dan `/orders/search` untuk Whatsplaid lakukan pertanyaan semasa perbualan.

Produk

Pulangan yang dijangka dengan `products`, termasuk ID, nama, deskripsi, harga, ketersediaan, stok, URL dan imej.

Pesanan

Respons yang dijangkakan dengan `orders`, termasuk nombor, status, pembayaran, penghantaran, jumlah, pelanggan, penjejakan dan item.

Webhooks

Peristiwa `LEAD_CAPTURE` menghantar data lead ke URL yang dikonfigurasikan. Titik hujung mesti memberi respons dengan HTTP 200 atau 204.

Keselamatan

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

Adakah anda perlu melaksanakan atau mengesahkan satu integrasi?

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

Buka Swagger