DocsΑναφορά API
Αναφορά API
Χτίστε πάνω από το BeeCastly με το πλήρες API REST μας. Διαχειριστείτε τις επαφές, στείλτε μηνύματα, δημιουργήστε καμπάνιες και διαμορφώστε τα webhook μέσω προγραμματισμού.
Βασική διεύθυνση URL
https://beecastly.com/api/v1Every endpoint that accepts an API key lives under /api/v1. The key identifies your workspace — there is no tenant header to send.
Γρήγορη εκκίνηση
curl "https://beecastly.com/api/v1/contacts?page=1&limit=20" \ -H "x-api-key: YOUR_API_KEY"
Πιστοποίηση
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.
Τελικά σημεία API
Μορφή απόκρισης
Κάθε απάντηση είναι JSON με την ίδια μορφή:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Όρια ποσοστού
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:
429with codeAPI_KEY_RATE_LIMITED. - Per workspace, per day — shared by all your keys, resets at 00:00 UTC. Over it:
429with codeAPI_DAILY_LIMITand aRetry-Afterheader. Every response carriesX-Daily-LimitandX-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.