Docsمرجع API
مرجع API
با REST API با امکانات کامل، در بالای BeeCastly بسازید. مخاطبین را مدیریت کنید، پیام ارسال کنید، کمپین ایجاد کنید، و وب هوک ها را به صورت برنامه ای پیکربندی کنید.
URL پایه
https://beecastly.com/apiتمام نقاط پایانی 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
فرمت پاسخ
همه پاسخ ها از فرمت JSON سازگار پیروی می کنند:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}محدودیت های نرخ
ردیف رایگان: 100 درخواست در دقیقه
سطح حرفه ای: 1000 درخواست در دقیقه
شرکت: محدودیت های سفارشی
هدرهای محدودیت نرخ در هر پاسخ گنجانده شده است: X-RateLimit-Remaining