API दस्तावेज़

जानें कि हमारे API से कैसे कनेक्ट और इंटीग्रेट करें।

 
अपनी API कुंजी पाएँ

ऑथेंटिकेशन

सभी API एंडपॉइंट के लिए Bearer ऑथेंटिकेशन विधि से भेजी गई API कुंजी ज़रूरी है।

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

त्रुटियाँ

हमारा API किसी अनुरोध की सफलता या विफलता बताने के लिए सामान्य HTTP स्टेटस कोड का उपयोग करता है।

{
    "errors": [
        {
            "title": "\u0906\u092a\u0915\u0947 \u092a\u093e\u0938 API \u0915\u0940 \u092a\u0939\u0941\u0901\u091a \u0928\u0939\u0940\u0902 \u0939\u0948\u0964",
            "status": 401
        }
    ]
}
200 अनुरोध सफलतापूर्वक पूरा हुआ
400 गलत अनुरोध – ज़रूरी पैरामीटर मौजूद नहीं हैं या अमान्य हैं
401 अनधिकृत – API कुंजी मौजूद नहीं है या अमान्य है
404 अनुरोधित संसाधन नहीं मिला
429 बहुत ज़्यादा अनुरोध – अनुरोध सीमा पार हो गई
500 आंतरिक सर्वर त्रुटि – समस्या हमारी ओर से है
जब तक अलग से न बताया जाए, सभी API एंडपॉइंट परिणाम UTC समय क्षेत्र में होते हैं।
उपयोगकर्ता
टीमें
टीम सदस्य
टीम का सदस्य
खाता लॉग