Skip to main content
DocsRéférence API

Référence API

Développez BeeCastly avec notre API REST complète. Gérez les contacts, envoyez des messages, créez des campagnes et configurez les webhooks par programmation.

URL de base

https://beecastly.com/api

Tous les points de terminaison de l'API sont relatifs à cette URL de base. Les demandes doivent inclure une clé API ou un jeton JWT valide.

Démarrage rapide

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"

Authentification

Toutes les demandes nécessitent une authentification via l'un des :

  • Clé API - Transmettez l'autorisation : en-tête Bearer YOUR_API_KEY
  • Jeton JWT — Obtenu à partir de POST /auth/login

De plus, incluez votre identifiant de locataire : x-tenant-id : YOUR_TENANT_ID

Voir le guide d'authentification complet →

Points de terminaison de l'API

Format de réponse

Toutes les réponses suivent un format JSON cohérent :

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

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

Limites de taux

Niveau gratuit : 100 requêtes/minute

Niveau Pro : 1 000 requêtes/minute

Entreprise : limites personnalisées

Les en-têtes de limite de débit sont inclus dans chaque réponse : X-RateLimit-Remaining