الوثائق
REST API

API التجربة الافتراضية

ادمج التجربة الافتراضية من Irisphera في متجر أو تطبيق مخصص عبر REST API: المصادقة، وجلسات المتسوقين، وإنشاء التجربة الافتراضية.

اطلب مفتاح API
في هذه الصفحة
  1. قبل أن تبدأ
  2. نظرة عامة
  3. المصادقة
  4. نقاط النهاية باختصار
  5. 1. أضف منتجاتك
  6. 2. أنشئ جلسة متسوق
  7. 3. أنشئ تجربة افتراضية
  8. الأخطاء
  9. الاستخدام

قبل أن تبدأ#

  • مفتاح API للتاجر تصدره Irisphera
  • خادم تتحكم فيه، للحفاظ على سرية المفتاح وإنشاء جلسات المتسوقين
  • منتجات في مجموعة Irisphera، معرَّفة برمز SKU الخاص بك

نظرة عامة#

يُقدَّم الـ API من https://api.irisphera.com ويُرجع الأخطاء بصيغة application/problem+json. تبلغ تكلفة كل عملية إنشاء تجربة افتراضية 0.06 يورو. راجع حاسبة التكلفة في صفحة الأسعار.

يُشارَك مرجع الـ API الكامل مع مفتاح API الخاص بك. تغطي هذه الصفحة المسار الرئيسي.

المصادقة#

الجهة المستدعيةالترويسةالاستخدام
خادمكMERCHANT-API-KEY: <key>الكتالوج وجلسات المتسوقين والاستخدام. لا تضعه أبدًا في كود المتصفح أو تطبيقات الجوال.
متصفح المتسوق أو تطبيقهAuthorization: Bearer <token>استدعاءات التجربة الافتراضية، برمز قصير الصلاحية يُنشئه خادمك.

نقاط النهاية باختصار#

Methodالمسارالغرض
POST/merchant/v2/collection-contextالحصول على القناة الخاصة بجلسات المتسوقين
POST/merchant/v2/shopper-sessionsفتح جلسة متسوق
POST/merchant/v2/shopper-sessions/{sessionId}/access-tokensتجديد رمز المتسوق
GET/shopper/v2/stylist-preview/{skuCustomId}التحقق مما إذا كان المنتج يدعم التجربة الافتراضية
POST/shopper/v2/stylist-previewإنشاء تجربة افتراضية
GET/merchant/v1/subscriptionالتحقق من الحصة والاستخدام

1. أضف منتجاتك#

أنشئ مجموعة وأضف إليها المنتجات، مفهرسة برمز SKU الخاص بك (skuCustomId). يمكنك أيضًا استيراد مجموعة من رابط موجز.

2. أنشئ جلسة متسوق#

على خادمك، اجلب قناتك مرة واحدة عبر POST /merchant/v2/collection-context، ثم افتح جلسة لكل متسوق. تتضمن الاستجابة accessToken ووقت انتهاء صلاحيته expiresAt. جدّده عبر POST /merchant/v2/shopper-sessions/{sessionId}/access-tokens.

إنشاء جلسة
curl https://api.irisphera.com/merchant/v2/shopper-sessions \
  -H "MERCHANT-API-KEY: $IRISPHERA_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channelId": "<channelId>",
    "currentIdentity": {
      "namespace": "<namespace>",
      "kind": "ANONYMOUS",
      "externalId": "visitor-123"
    }
  }'

3. أنشئ تجربة افتراضية#

تحقق من جاهزية المنتج عبر GET /shopper/v2/stylist-preview/{skuCustomId}. إذا كانت الفئة UNAVAILABLE، فلا تعرض التجربة الافتراضية له.

ثم أرسل صورة المتسوق مع رمز SKU للمنتج. تحتوي الاستجابة على generatedImage بصيغة WebP مرمّزة base64، إضافة إلى resultUrl يبقى صالحًا لمدة 24 ساعة.

إنشاء تجربة افتراضية
curl https://api.irisphera.com/shopper/v2/stylist-preview \
  -H "Authorization: Bearer $SHOPPER_TOKEN" \
  -F skuCustomId=DRESS-LILAC-S \
  -F [email protected] \
  -F isFaceBlurred=false
ملاحظة

صيغ الصور المقبولة: PNG وJPEG وWebP وAVIF.

الأخطاء#

تستخدم الأخطاء صيغة application/problem+json، مع حالة وعنوان وتفاصيل يمكنك تسجيلها.

مهم

تعني الاستجابة 420 أنه تعذّر استخدام صورة المتسوق. اطلب منه صورة أخرى بدلًا من إعادة المحاولة بالصورة نفسها.

الاستخدام#

تحقق من حصتك واستخدامك الحالي عبر GET /merchant/v1/subscription.

هل كانت هذه الصفحة مفيدة؟

تحتاج مساعدة؟ يمكن لفريقنا تثبيت Irisphera معك ومراجعة كتالوجك قبل الإطلاق.

تحدث مع الفريق