DocsRujukan API

Rujukan API

Bina di atas BeeCastly dengan API REST berciri penuh kami. Urus kenalan, hantar mesej, buat kempen dan konfigurasikan webhook secara pemrograman.

URL asas

https://beecastly.com/api

Semua titik akhir API adalah relatif kepada URL asas ini. Permintaan mesti termasuk kunci API atau token JWT yang sah.

Mula Pantas

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"

Pengesahan

Semua permintaan memerlukan pengesahan melalui salah satu daripada:

Kunci API — Lulus dalam Pengepala Kebenaran: Pembawa YOUR_API_KEY
Token JWT — Diperolehi daripada POST /auth/login

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

Lihat panduan pengesahan penuh →

Titik Akhir API

Pengesahan

Log masuk, daftar, kunci API, token JWT

Kenalan

Operasi CRUD, teg, segmen, medan tersuai

Mesej

Hantar WhatsApp, E-mel, SMS. Ambil perbualan

Kempen

Buat, jadualkan dan jejaki kempen

Webhooks

Langganan acara, muatan, pengesahan

Bot

Sesi bot AI, mesej dan data latihan

Format Respons

Semua jawapan mengikut format JSON yang konsisten:

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

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

Had Kadar

Peringkat percuma: 100 permintaan/minit

Peringkat Pro: 1,000 permintaan/minit

Perusahaan: Had tersuai

Pengepala had kadar disertakan dalam setiap respons: X-RateLimit-Remaining