Ideal House
تخطّي إلى المحتوى

Ideal House Product Import API#

استخدم Product Import API لاستيراد المنتجات وعرض قائمتها وحذفها منطقيًا من كتالوج Ideal House. تقبل عمليات الاستيراد الدفعي من 1 إلى 500 منتج وتُعالَج بصورة غير متزامنة. أما عمليتا عرض القائمة والحذف فتُعالَجان بصورة متزامنة.

عنوان URL الأساسي#

text
https://sdkapi.ideal.house

استخدم HTTPS لجميع الطلبات. يتم ترميز أجسام طلب واستجابة JSON بالترميز UTF-8.

قبل أن تبدأ#

سيوفر Ideal House القيم التالية أثناء الإعداد:

  • Shop ID
  • Client ID
  • Client Secret

تُعدّ Client ID وClient Secret بيانات اعتماد خاصة بالخادم. لا تكشف Client Secret أبدًا في شيفرة المتصفح أو تطبيقات الهاتف أو المستودعات العامة أو السجلات أو أي بيئة أخرى من جانب العميل.

المصادقة#

قم بتضمين هذه الرؤوس مع كل طلب:

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

بالنسبة للطلبات التي تحتوي على نص JSON، قم أيضًا بتضمين ما يلي:

http
Content-Type: application/json

ال shopId في الطلب يجب أن يتطابق مع المتجر المرتبط ببيانات الاعتماد. يعود عدم التطابق 403 Forbidden.

ملخص واجهة برمجة التطبيقات (API)#

الطريقةالمسارالغرض
POST/product-import/productsإرسال دفعة استيراد منتج غير متزامن.
GET/product-import/products/statusاحصل على مهمة الاستيراد الحالية أو الأحدث.
GET/product-import/productsقائمة المنتجات الحالية للمتجر.
DELETE/product-import/productsقم بحذف منتج واحد بشكل منطقي حسب معرف المنتج أو SKU.

سير استيراد الدفعات#

  1. إرسال دفعة المنتج مع POST /product-import/products.
  2. احفظ jobId المُعاد في الاستجابة 202 Accepted.
  3. استعلم دوريًا عبر GET /product-import/products/status كل 2 إلى 5 ثوانٍ.
  4. أوقف الاستعلام الدوري عندما تصبح الحالة completed أو failed.
  5. إذا كانت المهمة في حالة completed، فافحص failedCount وfailures بحثًا عن أخطاء على مستوى العناصر.

يمكن أن تكون مهمة استيراد واحدة فقط نشطة لمتجر في المرة الواحدة.