البنية الموحدة
تتبع جميع endpoints في OneClickDz Flexy API v3 بنية استجابة متسقة، مما يسهّل التعامل مع الاستجابات في تطبيقك.استجابة النجاح
عند نجاح الطلب، تتبع الاستجابة هذه البنية:الحقول
استجابة الخطأ
عند فشل الطلب، تتبع الاستجابة هذه البنية:الحقول
أمثلة على الاستجابة
رصيد الحساب
إرسال شحن الهاتف المحمول
قائمة المعاملات (مع التصفح بالصفحات)
التصفح بالصفحات
تتضمن endpoints القوائم بيانات التصفح بالصفحات في الاستجابة:حقول التصفح بالصفحات
معلمات الاستعلام للتصفح بالصفحات
تحكّم في التصفح بالصفحات باستخدام هذه المعلمات:رموز حالة HTTP
تستخدم API رموز حالة HTTP المعيارية:حتى لرموز الحالة غير 200، تتبع الاستجابة تنسيق الخطأ القياسي.
معرّف الطلب (Request ID)
تتضمن كل استجابةrequestId فريدًا:استخدامات Request ID
التصحيح
تتبع الطلبات عبر السجلات وتحديد المشكلات
الدعم الفني
إدراجه في تذاكر الدعم للحصول على حل أسرع
التدقيق
ربط الطلبات بالمعاملات
المراقبة
تتبع تدفق الطلبات عبر الأنظمة
نوع المحتوى
تستخدم جميع الطلبات والاستجابات JSON:ترويسات الطلب
ترويسات الاستجابة
التعامل مع الاستجابات
أفضل الممارسات
تحقق دائماً من حقل success
تحقق دائماً من حقل success
سجّل Request IDs
سجّل Request IDs
معالجة Pagination
معالجة Pagination
تحليل الطوابع الزمنية
تحليل الطوابع الزمنية
دفع الفواتير
تستخدم واجهة دفع الفواتير (Bill Payment API) علىhttps://api.oneclickdz.com نفس المغلّف الموصوف أعلاه: success وdata وmeta وrequestId عند النجاح، وsuccess وerror وrequestId عند الفشل.ثلاث تفاصيل خاصة بها:- التصفح بالصفحات موجود في
meta. يُرجعGET /v3/bills/transactionsحقلdataكمصفوفة بسيطة، معtotalوlimitوoffsetفيmetaإلى جانبtimestamp. requestIdموجود دائمًا — في جسم كل استجابة، وفي ترويسةX-Request-Idلكل استجابة. سجّله مقابل طلبك الخاص؛ فهو الشيء الوحيد الذي يحتاجه الدعم الفني.- أحد الـ endpoints يُرجع بيانات ثنائية. تنزيل الإيصال يُرسل ملف الإيصال نفسه، لذا لا يوجد مغلّف JSON عند النجاح ويكون
X-Request-Idهو المكان الوحيد الذي يظهر فيه معرّف الربط. أما حالات الفشل فيه فتستخدم مغلّف JSON المعتاد.
جلب المعاملة بالمعرّف
كائن المعاملة، حقلًا حقلًا
نظرة عامة على دفع الفواتير
كيف يتكامل المسار بأكمله
الخطوات التالية
معالجة الأخطاء
تعلّم كيفية التعامل مع الأخطاء بفعالية
Endpoints الأساسية
استكشف جميع الـ endpoints المتاحة

