كيف تعمل واجهة برمجة تطبيقات الدُفعات؟
تتيح نقطة نهاية واجهة برمجة تطبيقات الدُفعات، كما هو موثّق هنا، للمستخدمين إرسال طلبات للمعالجة الدفعية غير المتزامنة. سنعالج هذه الطلبات خلال 24 ساعة. ستُقرأ تفاصيل كل طلب من ملف تم تحميله مسبقًا، وستُكتب الاستجابات في ملف إخراج. يمكنك الاستعلام عن كائن الدُفعة للحصول على تحديثات الحالة والنتائج.
ما تسعير واجهة برمجة تطبيقات الدُفعات؟
سيُقدَّم كل نموذج بخصم 50% على التكلفة مقارنةً بواجهات برمجة التطبيقات المتزامنة. إليك المزيد من المعلومات حول تسعير واجهة API لدينا.
ما النماذج التي يمكنني استخدامها في الدُفعات؟
تتوفر واجهة برمجة تطبيقات الدُفعات على نطاق واسع عبر معظم نماذجنا، ولكن ليس كلها. يرجى الرجوع إلى مستندات مرجع النماذج للتأكد من أن النموذج الذي تستخدمه يدعم واجهة برمجة تطبيقات الدُفعات.
ماذا يحدث إذا لم تُكمل واجهة API طلبي ضمن الوقت الموعود؟
نهدف إلى إنجاز جميع الطلبات خلال 24 ساعة. إذا انتهت صلاحية دُفعة (أي تعذّر إكمالها ضمن نافذة وقت اتفاقية مستوى الخدمة (SLA))، فسيتم إلغاء العمل المتبقي وإرجاع أي عمل اكتمل بالفعل. سيتم فرض رسوم على المطوّرين مقابل أي عمل مكتمل.
ما الحد الأقصى لعدد الطلبات التي يمكنني إدراجها في دُفعة؟
تفرض واجهات برمجة تطبيقات التضمينات حدًا قدره مليون طلب في قائمة الانتظار في كل مرة.
بالنسبة إلى جميع واجهات برمجة التطبيقات الأخرى، لا يوجد حد لعدد الطلبات التي يمكنك إدراجها في دُفعة؛ لكن لكل مستوى استخدام حد استخدام دفعي مرتبط به. يشمل حدّ الاستخدام الدفعي لديك الحد الأقصى لعدد رموز الإدخال التي لديك في قائمة الانتظار في وقت واحد. يمكنك العثور على حدود الاستخدام الخاصة بك هنا.
هل يمكنني تغيير الوقت المستغرق لتلقي رد من واجهة برمجة تطبيقات الدُفعات؟
نافذة الوقت المحددة حاليًا لدينا هي 24 ساعة. لا يمكننا حاليًا تغيير هذه الفترة الزمنية.
هل البث مدعوم في واجهة برمجة تطبيقات الدُفعات؟
لا، البث غير مدعوم في واجهة برمجة تطبيقات الدُفعات. تُرجع طلبات الدُفعات النتائج عبر ملفات الإخراج بدلًا من الاستجابات المتدفقة.
هل الصور مدعومة في واجهة برمجة تطبيقات الدُفعات؟
نعم، الصور مدعومة في واجهة برمجة تطبيقات الدُفعات.
تلقيت رسالة خطأ «The URL provided for this request does not prefix-match the batch endpoint». ماذا عليّ أن أفعل؟
إذا تلقيت هذا الخطأ، فهذا يعني أن عنوان URL لديك منسّق بشكل غير صحيح لنقطة نهاية واجهة برمجة تطبيقات الدُفعات. يرجى الرجوع إلى وثائقنا هنا للتأكد من أنك تستدعي نقطة النهاية بشكل صحيح.
هل يُحتسب استخدام واجهة برمجة تطبيقات الدُفعات ضمن حدود الاستخدام الأخرى لدي؟
حدود استخدام واجهة برمجة تطبيقات الدُفعات منفصلة تمامًا عن الحدود الحالية.
ماذا يحدث إذا أُلغيت دُفعة؟
إذا أُلغيت دُفعة يدويًا، فسيتم إرجاع أي نتائج اكتملت بالفعل. سيتم فرض رسوم على المطوّرين مقابل أي عمل مكتمل.
ماذا يحدث إذا انتهت صلاحية دُفعة؟
إذا انتهت صلاحية دُفعة (أي تعذّر إكمالها ضمن نافذة وقت اتفاقية مستوى الخدمة (SLA))، فسيتم إلغاء العمل المتبقي وإرجاع أي عمل اكتمل بالفعل. سيتم فرض رسوم على المطوّرين مقابل أي عمل مكتمل.
ما الحالات التي يمكن أن أتوقعها في مهام الدُفعات؟
يمكن أن تكون لمهمة الدُفعة أي من الحالات التالية: قيد التحقق، فشلت، قيد التنفيذ، قيد الإنهاء، مكتملة، منتهية الصلاحية، قيد الإلغاء، وملغاة. إذا كنت تتحقق من قيم حالة API برمجيًا، فاستخدم القيم الحرفية بالأحرف الصغيرة: validating وfailed وin_progress وfinalizing وcompleted وexpired وcancelling وcancelled.
قيد التحقق: يجري التحقق من صحة الملف المحمّل قبل أن تبدأ الدُفعة.
فشلت: فشل الملف في عملية التحقق من الصحة.
قيد التنفيذ: تم التحقق من صحة الملف بنجاح وعملية الدُفعة جارية.
قيد الإنهاء: اكتملت مهمة الدُفعة ويجري إعداد النتائج.
مكتملة: اكتملت مهمة الدُفعة والنتائج جاهزة.
منتهية الصلاحية: تعذّر إكمال الدُفعة ضمن نافذة وقت اتفاقية مستوى الخدمة (SLA).
قيد الإلغاء: بدأ إلغاء مهمة الدُفعة.
ملغاة: أُلغيت مهمة الدُفعة.
كيف يمكنني التحقق من مهام الدُفعات التي أنشأتها بالفعل؟
يمكنك الحصول على قائمة بجميع مهام الدُفعات لديك باستخدام استدعاء API المحدد هنا.
هل عدم الاحتفاظ بالبيانات مدعوم في نقطة النهاية هذه؟
إذا كان عدم الاحتفاظ بالبيانات مفعّلًا لمؤسستك، فيُرجى ملاحظة أن عدم الاحتفاظ بالبيانات لا ينطبق على واجهة برمجة تطبيقات الدُفعات. يمكن لمؤسسات ZDR إنشاء مهام دُفعات، لكن يتم الاحتفاظ بملفات إدخال الدُفعات والمخرجات والأخطاء والآثار الوسيطة وفقًا لسياسات الاحتفاظ المكوّنة للدُفعات وخدمة الملفات وSediment.
