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/apiAng lahat ng mga endpoint ng API ay nauugnay sa base URL na ito. Dapat may kasamang valid na API key o JWT token ang mga kahilingan.
Mabilis na Pagsisimula
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"
Pagpapatunay
Ang lahat ng mga kahilingan ay nangangailangan ng pagpapatunay sa pamamagitan ng isa sa:
- API Key — Ipasa ang Authorization: Bearer YOUR_API_KEY header
- JWT Token — Nakuha mula sa POST /auth/login
Bukod pa rito, isama ang iyong tenant ID: x-tenant-id: YOUR_TENANT_ID
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 kampanya
Lumikha, mag-iskedyul, at subaybayan ang mga kampanya
Mga Webhook
Mga subscription sa event, payload, pag-verify
Mga bot
Mga session ng AI bot, mensahe, at data ng pagsasanay
Format ng Tugon
Ang lahat ng mga tugon ay sumusunod sa isang pare-parehong format ng JSON:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Mga Limitasyon sa Rate
Libreng tier: 100 kahilingan/minuto
Pro tier: 1,000 kahilingan/minuto
Enterprise: Mga custom na limitasyon
Ang mga header ng limitasyon sa rate ay kasama sa bawat tugon: X-RateLimit-Remaining