DocsReference API

Reference API

Stavte na BeeCastly s naším plně vybaveným REST API. Spravujte kontakty, posílejte zprávy, vytvářejte kampaně a konfigurujte webhooky programově.

Základní URL

https://beecastly.com/api

Všechny koncové body API jsou relativní k této základní adrese URL. Požadavky musí obsahovat platný klíč API nebo token JWT.

Rychlý 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"

Autentizace

Všechny požadavky vyžadují ověření prostřednictvím jednoho z:

Klíč API — Předejte záhlaví Authorization: Bearer YOUR_API_KEY
JWT Token — Získáno z POST /auth/login

Dále uveďte své ID tenanta: x-tenant-id: YOUR_TENANT_ID

Viz úplný průvodce ověřením →

Koncové body API

Autentizace

Přihlášení, registrace, klíče API, tokeny JWT

Kontakty

Operace CRUD, značky, segmenty, uživatelská pole

Zprávy

Poslat WhatsApp, e-mail, SMS. Načítat konverzace

Kampaně

Vytvářejte, plánujte a sledujte kampaně

Webhooky

Předplatné událostí, užitečné zatížení, ověřování

roboti

Relace, zprávy a tréninková data AI botů

Formát odpovědi

Všechny odpovědi mají konzistentní formát JSON:

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

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

Omezení sazby

Volná úroveň: 100 požadavků/minutu

Profesionální úroveň: 1 000 požadavků/minutu

Podnik: Vlastní limity

Záhlaví rychlostního limitu jsou součástí každé odpovědi: X-RateLimit-Remaining