Skip to main content

البنية الموحدة

تتبع جميع endpoints في OneClickDz Flexy API v3 بنية استجابة متسقة، مما يسهّل التعامل مع الاستجابات في تطبيقك.

استجابة النجاح

عند نجاح الطلب، تتبع الاستجابة هذه البنية:

الحقول

boolean
مطلوب
دائمًا true للاستجابات الناجحة
object
مطلوب
يحتوي على محتوى الاستجابة. تختلف البنية حسب كل endpoint.
object
بيانات وصفية إضافية حول الاستجابة
string
معرّف فريد لهذا الطلب. استخدمه عند التواصل مع الدعم الفني.

استجابة الخطأ

عند فشل الطلب، تتبع الاستجابة هذه البنية:

الحقول

boolean
مطلوب
دائمًا false لاستجابات الخطأ
object
مطلوب
يحتوي على معلومات الخطأ
string
معرّف فريد لهذا الطلب. أدرجه عند الإبلاغ عن المشكلات.

أمثلة على الاستجابة

رصيد الحساب

إرسال شحن الهاتف المحمول

قائمة المعاملات (مع التصفح بالصفحات)

التصفح بالصفحات

تتضمن endpoints القوائم بيانات التصفح بالصفحات في الاستجابة:

حقول التصفح بالصفحات

integer
رقم الصفحة الحالية (مفهرسة من 1)
integer
عدد العناصر في كل صفحة
integer
العدد الإجمالي للصفحات المتاحة
integer
العدد الإجمالي للعناصر في جميع الصفحات

معلمات الاستعلام للتصفح بالصفحات

تحكّم في التصفح بالصفحات باستخدام هذه المعلمات:
تحقق دائمًا من totalPages لمعرفة متى تتوقف عن التصفح.

رموز حالة HTTP

تستخدم API رموز حالة HTTP المعيارية:
حتى لرموز الحالة غير 200، تتبع الاستجابة تنسيق الخطأ القياسي.

معرّف الطلب (Request ID)

تتضمن كل استجابة requestId فريدًا:

استخدامات Request ID

التصحيح

تتبع الطلبات عبر السجلات وتحديد المشكلات

الدعم الفني

إدراجه في تذاكر الدعم للحصول على حل أسرع

التدقيق

ربط الطلبات بالمعاملات

المراقبة

تتبع تدفق الطلبات عبر الأنظمة
سجّل دائمًا requestId لكل استدعاء API تجريه. إنه لا يُقدّر بثمن للتصحيح.

نوع المحتوى

تستخدم جميع الطلبات والاستجابات JSON:

ترويسات الطلب

ترويسات الاستجابة

التعامل مع الاستجابات

أفضل الممارسات

الخطوات التالية

معالجة الأخطاء

تعلّم كيفية التعامل مع الأخطاء بفعالية

Endpoints الأساسية

استكشف جميع الـ endpoints المتاحة