DocsSanggunian ng API

Sanggunian ng API

Bumuo sa ibabaw ng BeeCastly gamit ang aming buong tampok na REST API. Pamahalaan ang mga contact, magpadala ng mga mensahe, lumikha ng mga kampanya, at i-configure ang mga webhook sa programmatically.

Base URL

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.

Mabilis na Pagsisimula

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

Pagpapatunay

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.

Tingnan ang buong gabay sa pagpapatunay →

Mga Endpoint ng API

Pagpapatunay

Mag-login, magparehistro, API key, JWT token

Mga contact

Mga pagpapatakbo ng CRUD, tag, segment, custom na field

Mga mensahe

Magpadala ng WhatsApp, Email, SMS. Kunin ang mga pag-uusap

Mga Webhook

Mga subscription sa event, payload, pag-verify

Format ng Tugon

Bawat response ay JSON na may parehong hugis:

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

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

Mga Limitasyon sa 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.