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/v1

Every endpoint that accepts an API key lives under /api/v1. The key identifies your workspace — there is no tenant header to send.

Mulai Cepat

curl "https://beecastly.com/api/v1/contacts?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

Otentikasi

Send your API key in the x-api-key header. Create keys under Settings → API Keys and choose their access when you create them:

Read only — GET requests.
Read & write — also POST: send messages, create contacts.

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

Webhook

Langganan acara, muatan, verifikasi

Format Respons

Setiap respons berupa JSON dengan bentuk yang sama:

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

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

Batasan Tarif

Two limits apply to every API-key request, both set by your plan:

Per key, per minute — the plan's ceiling, or the key's own limit if lower. Over it: 429 with code API_KEY_RATE_LIMITED.
Per workspace, per day — shared by all your keys, resets at 00:00 UTC. Over it: 429 with code API_DAILY_LIMIT and a Retry-After header. Every response carries X-Daily-Limit and X-Daily-Remaining.

Plan	Requests / minute (per key)	Requests / day (workspace)	Webhook endpoints
Free	5	100	2
Starter	20	2,500	10
Growth	100	15,000	30
Pro	300	60,000	100
Agency	1,000	500,000	Unlimited

The BeeCastly Chrome extensions use their own keys and do not count toward the daily allowance.