DocsReferensi API

Referensi API

Bangun di atas BeeCastly dengan REST API kami yang berfitur lengkap. Kelola kontak, kirim pesan, buat kampanye, dan konfigurasikan webhook secara terprogram.

URL dasar

https://beecastly.com/api

Semua titik akhir API bersifat relatif terhadap URL dasar ini. Permintaan harus menyertakan kunci API atau token JWT yang valid.

Mulai Cepat

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

Otentikasi

Semua permintaan memerlukan otentikasi melalui salah satu dari:

Kunci API — Masukkan Otorisasi: Pembawa header YOUR_API_KEY
Token JWT — Diperoleh dari POST /auth/login

Selain itu, sertakan ID penyewa Anda: x-tenant-id: YOUR_TENANT_ID

Lihat panduan otentikasi lengkap →

Titik Akhir API

Otentikasi

Masuk, daftar, kunci API, token JWT

Kontak

Operasi CRUD, tag, segmen, bidang khusus

Pesan

Kirim WhatsApp, Email, SMS. Ambil percakapan

Kampanye

Buat, jadwalkan, dan lacak kampanye

Webhook

Langganan acara, muatan, verifikasi

Bot

Sesi bot AI, pesan, dan data pelatihan

Format Respons

Semua tanggapan mengikuti format JSON yang konsisten:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

Batasan Tarif

Tingkat gratis: 100 permintaan/menit

Tingkat Pro: 1.000 permintaan/menit

Perusahaan: Batasan khusus

Header batas tarif disertakan dalam setiap respons: X-RateLimit-Remaining