Semua request ke API Conexchat diautentikasi menggunakan API Key. Key dapat dibuat melalui dashboard di menu Settings → API Keys. Sertakan API Key di setiap request melalui HTTP header X-API-Key.
Mulai kirim pesan dalam 3 langkah sederhana.
X-API-Key pada setiap request.Sertakan API Key di header berikut pada setiap request HTTP.
Conexchat membedakan dua jenis environment melalui prefix key.
| Prefix | Environment | Keterangan |
|---|---|---|
| wc_live_ | Live | Key untuk production. Semua aksi bersifat nyata. |
| wc_test_ | Sandbox | Key untuk testing & development. Tidak ada pesan yang benar-benar terkirim. |
Jika API Key tidak valid atau tidak disertakan, API akan mengembalikan error berikut.
| HTTP Code | Error | Penyebab |
|---|---|---|
| 401 | Unauthorized | Header X-API-Key tidak ada atau kosong. |
| 403 | Forbidden | API Key valid tapi tidak memiliki izin untuk endpoint ini. |
| 429 | Too Many Requests | Rate limit tercapai. Coba lagi setelah beberapa saat. |
API memberlakukan batasan request per menit untuk menjaga stabilitas layanan.
| Paket | Limit per Menit | Burst Max |
|---|---|---|
| Starter | 60 req/mnt | 100 |
| Business | 300 req/mnt | 500 |
| Enterprise | Tidak terbatas | Custom SLA |
Semua endpoint menggunakan format JSON yang konsisten. Field success selalu ada untuk memudahkan pengecekan.
Platform ini telah bertransformasi menjadi AI Omnichannel. API berikut memungkinkan Anda untuk mengintegrasikan Livechat Widget dan Internal Messenger ke sistem eksternal Anda.
Kirim dan terima pesan Livechat dari website atau aplikasi Anda.
Kirim dan kelola pesan internal chat antar staf atau tim toko.
REST API lengkap untuk mengintegrasikan toko Anda dengan sistem eksternal — mobile app, ERP, CRM, POS, hingga platform automation seperti n8n dan Make.com. Gunakan Store API Key yang sama dengan API key utama Anda.
CRUD produk, varian, dan kategori toko Anda secara programatik.
| Query Param | Tipe | Keterangan |
|---|---|---|
| categoryId | string | Filter per kategori |
| search | string | Pencarian kata kunci |
| limit | number | Default 20, max 100 |
| page | number | Nomor halaman |
Baca dan update status order dari sistem eksternal Anda.
| Query Param | Tipe | Keterangan |
|---|---|---|
| status | string | pending | paid | processing | shipped | delivered | cancelled |
| limit | number | Default 20 |
| page | number | Nomor halaman |
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| status | string | required | Status baru order |
| trackingNumber | string | opsional | Nomor resi pengiriman |
| note | string | opsional | Catatan internal |
Sinkronisasi data pelanggan dengan CRM atau sistem eksternal Anda.
Update stok produk secara real-time dari sistem POS, gudang, atau ERP Anda.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| stock | number | required | Jumlah stok baru (absolute) |
| variantId | string | opsional | ID varian jika produk punya varian |
Daftarkan URL webhook toko Anda untuk menerima notifikasi real-time setiap kali ada event penting di toko. Gunakan bersama n8n, Make.com, atau aplikasi custom Anda.
| Event | Deskripsi | Kapan Terjadi |
|---|---|---|
| order.created | Order dibuat | Pelanggan submit checkout |
| checkout.completed | Checkout selesai | Order berhasil diproses sistem |
| payment.success | Pembayaran berhasil | Admin konfirmasi pembayaran |
| payment.failed | Pembayaran gagal | Pembayaran ditolak/expired |
| refund.processed | Refund diproses | Admin proses pengembalian dana |
| customer.registered | Pelanggan baru | Profil pelanggan pertama kali dibuat |
| cart.abandoned | Keranjang ditinggal | Cart tidak di-checkout > 24 jam |
| product.created | Produk baru | Admin tambah produk |
| product.updated | Produk diupdate | Admin edit produk/stok |
| stock.low | Stok hampir habis | Stok ≤ threshold |
| stock.out | Stok habis | Stok = 0 |
| shipment.created | Pengiriman dibuat | Nomor resi diinput |
| shipment.delivered | Terkirim | Status order jadi delivered |
| coupon.redeemed | Kupon digunakan | Pelanggan pakai kode promo |
| review.submitted | Ulasan masuk | Pelanggan kirim review produk |
Set atau update URL webhook dan pilih event yang ingin dipantau via API atau dari menu Toko Saya → Webhook Logs.
| Parameter | Tipe | Keterangan |
|---|---|---|
| webhookUrl | string | URL endpoint yang menerima POST webhook |
| webhookSecret | string | Secret untuk verifikasi header X-Webhook-Secret |
| webhookEvents | array | Array event ID yang ingin dipantau |
| Query Param | Tipe | Keterangan |
|---|---|---|
| event | string | Filter per event |
| status | string | success | failed |
| limit | number | Max 200 |
| offset | number | Pagination offset |
Setiap event dikirim sebagai HTTP POST dengan body JSON berikut.
API berbasis kecerdasan buatan yang membantu merchant mengotomatisasi pembuatan konten, meningkatkan keterlibatan pelanggan, dan mengoptimalkan penjualan. AI API menggunakan konfigurasi LLM (OpenRouter / OpenAI / Gemini) yang sudah Anda set di menu Pengaturan Toko → AI Sales Agent.
Generate deskripsi produk yang menarik dan mendorong konversi secara otomatis menggunakan AI.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| productName | string | required | Nama produk |
| category | string | opsional | Kategori produk |
| keywords | string | opsional | Kata kunci yang ingin ditonjolkan |
| tone | string | opsional | profesional | casual | luxury | friendly (default: profesional) |
| language | string | opsional | id | en (default: id) |
Terjemahkan nama, deskripsi, atau konten produk ke berbagai bahasa untuk menjangkau pasar internasional.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| text | string | required | Teks yang akan diterjemahkan |
| targetLanguage | string | opsional | en | id | zh | ar | ms (default: en) |
Generate SEO title, meta description, dan daftar keyword untuk meningkatkan visibilitas produk di mesin pencari.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| productName | string | required | Nama produk |
| description | string | opsional | Deskripsi produk |
| category | string | opsional | Kategori produk |
Rekomendasikan produk yang paling relevan berdasarkan profil dan histori belanja pelanggan.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| customerPhone | string | opsional | Nomor telepon pelanggan untuk rekomendasi personal |
| currentProductId | string | opsional | ID produk yang sedang dilihat |
| limit | number | opsional | Jumlah rekomendasi (default: 5) |
Hasilkan ringkasan analitik pelanggan yang actionable dari histori pembelian mereka menggunakan AI.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| customerPhone | string | required | Nomor telepon pelanggan (format: 628xxx) |
Generate pesan follow-up pelanggan yang personal dan efektif untuk berbagai skenario — order, abandoned cart, win-back, dan lainnya.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| customerName | string | required | Nama pelanggan |
| type | string | opsional | order_followup | abandoned_cart | win_back | promo | payment_reminder |
| orderId | string | opsional | Kode order (jika relevan) |
| context | string | opsional | Konteks tambahan untuk personalisasi |
Tingkatkan nilai rata-rata transaksi dengan rekomendasi produk upsell dan cross-sell yang cerdas berdasarkan AI.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| productId | string | * | ID produk utama yang sedang dilihat |
| cartItems | array | * | Array ID produk di keranjang (*salah satu wajib) |
Generate balasan ulasan pelanggan yang profesional, empati, dan konsisten — untuk ulasan positif maupun negatif.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
| reviewText | string | required | Teks ulasan dari pelanggan |
| rating | number | opsional | Rating 1-5 |
| customerName | string | opsional | Nama pelanggan |
| productName | string | opsional | Nama produk yang diulas |