QwikChat API Docs

Ringkasan API QwikChat

REST API per-bot untuk menyambungkan WhatsApp, mengirim pesan, serta mengelola kontak dan grup — langsung dari sistem Anda.

Base URL

Semua endpoint berada di bawah awalan berikut. Ganti {host} dengan domain tempat QwikChat Anda berjalan.

https://{host}/api/v1/client

Paket yang dibutuhkan

API ini termasuk dalam paket berbayar. Paket melekat pada WORKSPACE, dan setiap perangkat mengikuti paket workspace-nya — perangkat di workspace paket Gratis tetap bisa membuat API key, tetapi permintaannya akan ditolak dengan status 403: bukan karena key-nya salah, melainkan karena paket tokonya belum mencakup API.

Autentikasi

Setiap permintaan wajib menyertakan API key perangkat pada header Authorization — nilainya mentah, tanpa awalan "Bearer".

Authorization: nEo3xT9kQ2mLpVzR7bWq
API key bersifat rahasia dan mewakili satu perangkat (bot). Simpan di sisi server, jangan pernah taruh di kode klien (browser/aplikasi). Key hanya ditampilkan sekali saat dibuat, dan setiap key membawa izinnya sendiri. Lihat Mendapatkan API Key.

Format respons

Respons selalu berupa JSON. Permintaan yang berhasil mengembalikan status 2xx dengan data. Kegagalan mengembalikan kode status HTTP yang sesuai beserta pesan pada field error.

{
  "error": "invalid api key"
}

Kode status umum

KodeKeterangan
200Permintaan berhasil.
400Body atau parameter tidak valid.
401API key hilang atau tidak dikenal.
403Key-nya benar, tetapi paket workspace perangkat ini belum mencakup API — atau key-nya tidak membawa izin yang diperlukan endpoint ini.
409Perangkat belum tersambung untuk operasi ini.
429Terlalu banyak permintaan.
500Kesalahan pada server.