Docsהפניה ל-API
הפניה ל-API
בנה על גבי BeeCastly עם REST API המלא שלנו. נהל אנשי קשר, שלח הודעות, צור מסעות פרסום והגדר את ה-webhooks באופן פרוגרמטי.
כתובת האתר הבסיסית
https://beecastly.com/apiכל נקודות הקצה של ה-API הן ביחס לכתובת האתר הבסיסית הזו. בקשות חייבות לכלול מפתח 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 Token - הושג מ-POST /auth/login
בנוסף, כלול את מזהה הדייר שלך: x-tenant-id: YOUR_TENANT_ID
נקודות קצה של API
פורמט תגובה
כל התגובות עוקבות אחר פורמט JSON עקבי:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}מגבלות תעריף
שכבה חינם: 100 בקשות לדקה
שכבת מקצוענים: 1,000 בקשות לדקה
Enterprise: מגבלות מותאמות אישית
כותרות מגבלת שיעור כלולות בכל תגובה: X-RateLimit-Remaining