DocsReferință API

Referință API

Construiți-vă pe BeeCastly cu API-ul nostru REST cu funcții complete. Gestionați contacte, trimiteți mesaje, creați campanii și configurați webhook-uri în mod programatic.

Adresa URL de bază

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.

Pornire rapidă

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

Autentificare

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.

Consultați ghidul complet de autentificare →

Puncte finale API

Autentificare

Autentificare, înregistrare, chei API, jetoane JWT

Contacte

Operațiuni CRUD, etichete, segmente, câmpuri personalizate

Mesaje

Trimite WhatsApp, e-mail, SMS. Preluați conversații

Webhook-uri

Abonamente la evenimente, încărcături utile, verificare

Format de răspuns

Fiecare răspuns este JSON cu aceeași structură:

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

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

Limite de rate

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.