Referência de API
Construa com base no BeeCastly com nossa API REST completa. Gerencie contatos, envie mensagens, crie campanhas e configure webhooks de maneira programática.
URL base
https://beecastly.com/apiTodos os pontos finais da API são relativos a este URL base. As solicitações devem incluir uma chave de API válida ou um token JWT.
Início rápido
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"
Autenticação
Todas as solicitações requerem autenticação por meio de um dos seguintes:
- Chave de API - Passe o cabeçalho Authorization: Bearer YOUR_API_KEY
- Token JWT - obtido de POST /auth/login
Além disso, inclua seu ID de locatário: x-tenant-id: YOUR_TENANT_ID
Terminais de API
Autenticação
Login, registro, chaves de API, tokens JWT
Contatos
Operações CRUD, tags, segmentos, campos personalizados
Mensagens
Envie WhatsApp, e-mail, SMS. Buscar conversas
Campanhas
Crie, programe e acompanhe campanhas
Webhooks
Assinaturas de eventos, cargas úteis, verificação
Robôs
Sessões de bot de IA, mensagens e dados de treinamento
Formato de resposta
Todas as respostas seguem um formato JSON consistente:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Limites de taxa
Nível gratuito: 100 solicitações/minuto
Nível Pro: 1.000 solicitações/minuto
Empresa: limites personalizados
Os cabeçalhos de limite de taxa estão incluídos em cada resposta: X-RateLimit-Remaining