Dokumentacja API
Buduj na bazie BeeCastly dzięki naszemu w pełni funkcjonalnemu interfejsowi API REST. Zarządzaj kontaktami, wysyłaj wiadomości, twórz kampanie i programowo konfiguruj webhooki.
Bazowy adres URL
https://beecastly.com/apiWszystkie punkty końcowe interfejsu API odnoszą się do tego podstawowego adresu URL. Żądania muszą zawierać prawidłowy klucz API lub token JWT.
Szybki start
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"
Uwierzytelnianie
Wszystkie żądania wymagają uwierzytelnienia za pomocą jednego z:
- Klucz API — Przekaż nagłówek Authorization: Bearer YOUR_API_KEY
- Token JWT — uzyskany z POST /auth/login
Dodatkowo podaj identyfikator dzierżawcy: x-tenant-id: YOUR_TENANT_ID
Punkty końcowe interfejsu API
Uwierzytelnianie
Zaloguj się, zarejestruj, klucze API, tokeny JWT
Łączność
Operacje CRUD, tagi, segmenty, pola niestandardowe
Wiadomości
Wyślij WhatsApp, e-mail, SMS. Pobierz rozmowy
Kampanie
Twórz, planuj i śledź kampanie
Haki internetowe
Subskrypcje zdarzeń, ładunki, weryfikacja
Boty
Sesje botów AI, wiadomości i dane szkoleniowe
Forma odpowiedzi
Wszystkie odpowiedzi mają spójny format JSON:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Limity stawek
Poziom bezpłatny: 100 żądań/minutę
Poziom Pro: 1000 żądań/minutę
Przedsiębiorstwo: limity niestandardowe
Nagłówki limitu szybkości są zawarte w każdej odpowiedzi: X-RateLimit-Remaining