نظرة عامة
فهم استجابات API
تُرجع واجهة ByByBG API رموز HTTP القياسية للإشارة إلى نجاح الطلبات أو فشلها أو قيود الرفع أو حدود المعدل.
نصيحة:
تعامل دائمًا مع أخطاء API بشكل صحيح داخل تطبيقات الإنتاج لتحقيق استقرار وتجربة مستخدم أفضل.
STATUS CODES
رموز HTTP الشائعة
Code
Description
200
تمت إزالة الخلفية بنجاح.
400
طلب غير صالح أو ملف صورة مفقود.
401
مفتاح API مفقود أو غير صالح.
403
تم رفض الوصول.
413
ملف الصورة المرفوع كبير جدًا.
415
تنسيق صورة غير مدعوم.
429
طلبات كثيرة جدًا. تم تجاوز الحد المسموح.
500
خطأ داخلي أثناء المعالجة.
503
الخدمة غير متاحة مؤقتًا.
LIMITS
قيود الرفع
- الحد الأقصى لحجم الصورة المدعوم: 10 ميجابايت.
- التنسيقات المدعومة: PNG وJPG وJPEG وWEBP.
- تنسيق الإخراج الشفاف: PNG.
- قد يتم تطبيق حدود على عدد طلبات API.
- قد تؤدي الملفات الكبيرة إلى زيادة وقت المعالجة.
TROUBLESHOOTING
المشكلات الشائعة والحلول
مفتاح API غير صالح
تحقق من مفتاح API وترويسات الطلب قبل الإرسال.
صورة كبيرة الحجم
قم بضغط الصور قبل رفعها لتقليل الحجم وتحسين السرعة.
خطأ في الشبكة
تحقق من اتصال الإنترنت وتوفر الخادم الخلفي.
تجاوز الحد المسموح
قلّل معدل الطلبات أو قم بالترقية إلى خطة أعلى.
BEST PRACTICES
توصيات الإنتاج
- استخدم آليات إعادة المحاولة للطلبات الفاشلة.
- اعرض رسائل أخطاء سهلة الفهم للمستخدم.
- تحقق من الملفات قبل رفعها.
- قم بضغط الصور الكبيرة قبل الرفع.
- قم بتخزين الاستجابات الناجحة مؤقتًا عند الإمكان.
- راقب استخدام API وحدود الطلبات.
ERROR RESPONSE
مثال على استجابة خطأ JSON
{
"success": false,
"error": "Invalid API key"
}اكتمل التوثيق
أنت الآن جاهز لدمج واجهة ByByBG API داخل مواقع الويب وتطبيقات الهاتف ومنصات SaaS وأنظمة الأتمتة.