अवलोकन
API प्रतिक्रियाओं को समझना
ByByBG API सफल अनुरोधों, विफलताओं, अपलोड प्रतिबंधों और Rate Limits को दर्शाने के लिए मानक HTTP Status Codes लौटाती है।
सुझाव:
बेहतर स्थिरता और उपयोगकर्ता अनुभव के लिए प्रोडक्शन एप्लिकेशन में API त्रुटियों को हमेशा सही ढंग से संभालें।
STATUS CODES
सामान्य HTTP Status Codes
Code
Description
200
बैकग्राउंड सफलतापूर्वक हटाया गया।
400
अमान्य अनुरोध या इमेज फ़ाइल अनुपस्थित है।
401
API Key अनुपस्थित या अमान्य है।
403
पहुंच अस्वीकृत।
413
अपलोड की गई इमेज फ़ाइल बहुत बड़ी है।
415
असमर्थित इमेज फ़ॉर्मेट।
429
बहुत अधिक अनुरोध। Rate Limit पार हो गई है।
500
आंतरिक सर्वर प्रोसेसिंग त्रुटि।
503
सेवा अस्थायी रूप से उपलब्ध नहीं है।
LIMITS
अपलोड प्रतिबंध
- अधिकतम समर्थित इमेज आकार: 10MB।
- समर्थित फ़ॉर्मेट: PNG, JPG, JPEG और WEBP।
- पारदर्शी आउटपुट फ़ॉर्मेट: PNG।
- API अनुरोधों पर Rate Limit लागू हो सकती है।
- बड़ी फ़ाइलें प्रोसेसिंग समय बढ़ा सकती हैं।
TROUBLESHOOTING
सामान्य समस्याएँ और समाधान
अमान्य API Key
अनुरोध भेजने से पहले अपनी API Key और Request Headers की जाँच करें।
बड़ी इमेज
फ़ाइल आकार कम करने और गति बढ़ाने के लिए अपलोड से पहले इमेज को Compress करें।
नेटवर्क त्रुटि
इंटरनेट कनेक्शन और बैकएंड सर्वर की उपलब्धता की जाँच करें।
Rate Limit
अनुरोधों की आवृत्ति कम करें या अपनी API योजना को अपग्रेड करें।
BEST PRACTICES
प्रोडक्शन अनुशंसाएँ
- विफल अनुरोधों के लिए Retry Mechanisms का उपयोग करें।
- उपयोगकर्ता-अनुकूल त्रुटि संदेश प्रदर्शित करें।
- फ़ाइल भेजने से पहले अपलोड का सत्यापन करें।
- अपलोड से पहले बड़ी इमेज को Compress करें।
- जहाँ संभव हो सफल प्रतिक्रियाओं को Cache करें।
- API उपयोग और Request Limits की निगरानी करें।
ERROR RESPONSE
उदाहरण JSON त्रुटि प्रतिक्रिया
{
"success": false,
"error": "Invalid API key"
}दस्तावेज़ीकरण पूर्ण
अब आप ByByBG API को वेबसाइटों, मोबाइल ऐप्स, SaaS प्लेटफ़ॉर्म और ऑटोमेशन सिस्टम में इंटीग्रेट करने के लिए तैयार हैं।