مرجع واجهة برمجة التطبيقات
يمكنك البناء على BeeCastly من خلال واجهة REST API كاملة الميزات. إدارة جهات الاتصال وإرسال الرسائل وإنشاء الحملات وتكوين خطافات الويب برمجيًا.
عنوان URL الأساسي
https://beecastly.com/apiجميع نقاط نهاية واجهة برمجة التطبيقات مرتبطة بعنوان URL الأساسي هذا. يجب أن تتضمن الطلبات مفتاح API صالحًا أو رمز JWT المميز.
بداية سريعة
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"
المصادقة
تتطلب جميع الطلبات المصادقة عبر أحد:
- مفتاح API - قم بتمرير التفويض: حامل رأس YOUR_API_KEY
- رمز JWT - تم الحصول عليه من POST /auth/login
بالإضافة إلى ذلك، قم بتضمين معرف المستأجر الخاص بك: x-tenant-id: YOUR_TENANT_ID
نقاط نهاية API
المصادقة
تسجيل الدخول، التسجيل، مفاتيح API، رموز JWT
اتصالات
عمليات CRUD والعلامات والقطاعات والحقول المخصصة
رسائل
إرسال الواتساب، البريد الإلكتروني، الرسائل القصيرة. جلب المحادثات
الحملات
إنشاء الحملات وجدولتها وتتبعها
خطافات الويب
اشتراكات الأحداث والحمولات والتحقق
الروبوتات
جلسات روبوت الذكاء الاصطناعي والرسائل وبيانات التدريب
تنسيق الاستجابة
تتبع جميع الاستجابات تنسيق JSON ثابتًا:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}حدود المعدل
الطبقة المجانية: 100 طلب/الدقيقة
الطبقة الاحترافية: 1000 طلب/الدقيقة
المؤسسة: الحدود المخصصة
يتم تضمين رؤوس حدود المعدل في كل استجابة: X-RateLimit-Remaining