Docsएपीआई संदर्भ
एपीआई संदर्भ
हमारे पूर्ण विशेषताओं वाले REST API के साथ BeeCastly के शीर्ष पर निर्माण करें। संपर्क प्रबंधित करें, संदेश भेजें, अभियान बनाएं और वेबहुक को प्रोग्रामेटिक रूप से कॉन्फ़िगर करें।
आधार यूआरएल
https://beecastly.com/apiसभी एपीआई एंडपॉइंट इस बेस यूआरएल से संबंधित हैं। अनुरोधों में एक वैध एपीआई कुंजी या जेडब्ल्यूटी टोकन शामिल होना चाहिए।
त्वरित शुरुआत
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"
प्रमाणीकरण
सभी अनुरोधों के लिए इनमें से किसी एक के माध्यम से प्रमाणीकरण की आवश्यकता होती है:
- एपीआई कुंजी - प्राधिकरण में पास करें: अपना_एपीआई_की हेडर रखें
- JWT टोकन - POST /auth/लॉगिन से प्राप्त किया गया
इसके अतिरिक्त, अपनी किरायेदार आईडी शामिल करें: x-किरायेदार-आईडी: YOUR_TENANT_ID
एपीआई समापन बिंदु
प्रतिक्रिया प्रारूप
सभी प्रतिक्रियाएँ सुसंगत JSON प्रारूप का अनुसरण करती हैं:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}दर सीमाएँ
निःशुल्क स्तर: 100 अनुरोध/मिनट
प्रो टियर: 1,000 अनुरोध/मिनट
उद्यम: कस्टम सीमाएँ
प्रत्येक प्रतिक्रिया में दर सीमा शीर्षलेख शामिल होते हैं: X-RateLimit-Remaining