API-referencia
Építsen a BeeCastly tetejére a teljes funkcionalitású REST API-nkkal. Névjegyek kezelése, üzenetek küldése, kampányok létrehozása és webhookok programozott konfigurálása.
Alap URL
https://beecastly.com/apiAz összes API-végpont ehhez az alap URL-hez kapcsolódik. A kéréseknek tartalmazniuk kell egy érvényes API kulcsot vagy JWT tokent.
Gyors kezdés
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"
Hitelesítés
Minden kérés hitelesítést igényel a következők egyikén keresztül:
- API-kulcs – Adja meg az engedélyezést: hordozó YOUR_API_KEY fejlécet
- JWT token – A POST /auth/login parancsból szerezték be
Ezenkívül adja meg bérlői azonosítóját: x-tenant-id: YOUR_TENANT_ID
API-végpontok
Hitelesítés
Bejelentkezés, regisztráció, API kulcsok, JWT tokenek
Kapcsolatok
CRUD műveletek, címkék, szegmensek, egyéni mezők
Üzenetek
WhatsApp, e-mail, SMS küldése. Beszélgetések lekérése
Kampányok
Kampányok létrehozása, ütemezése és nyomon követése
Webhookok
Esemény-előfizetések, rakományok, ellenőrzés
Botok
AI bot munkamenetek, üzenetek és edzési adatok
Válasz formátum
Minden válasz következetes JSON-formátumot követ:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Kérési korlátok
Ingyenes szint: 100 kérés/perc
Pro szint: 1000 kérés/perc
Enterprise: Egyedi korlátok
Minden válasz tartalmazza a sebességkorlát fejléceit: X-RateLimit-Remaining