SocialHub.AI
الموارد · المطورون

REST API مرجع

71 نقاط النهاية عبر موارد 19. يُمكّنك SocialHub v2 REST API من إدارة المتاجر، وأعضاء برنامج الولاء، والنقاط، والقسائم، وعمليات الاستحواذ، وبرنامج السفراء، والتتبع. تتطلب جميع نقاط النهاية الإصدار Authorization: Bearer fl_live_… ما لم يُذكر خلاف ذلك.

عنوان URL الأساسيhttps://flash.socialhub.ai/api/v2

هذا المرجع يُطابق API. المباشر. إنه لقطة ثابتة لكتالوج نقاط النهاية، مُصنفة حسب المورد. للاطلاع على العقد المُحدّث باستمرار والقابل للقراءة آليًا (المعلمات، وبيانات الطلب، ومخططات الاستجابة)، راجع OpenAPI JSON →

المصادقة

المصادقة باستخدام مفتاح حامل

يتم التحقق من كل طلب باستخدام مفتاح SocialHub API (fl_live_…) المُرسل كرمز حامل. تكون المفاتيح مُخصصة لفريقك ولكل أداة على حدة - أنشئها وقم بإدارتها في حساب SocialHub الخاص بك.

curl https://flash.socialhub.ai/api/v2/members \
  -H "Authorization: Bearer fl_live_your_key_here"

هل تفضل إبقاء المفتاح النصي العادي خارج سجل أوامر shell؟ قم بتصديره كـ FLASH_API_KEY وقم بالإشارة إلى متغير البيئة.

وضع الاختبار (بيئة تجريبية)

قم بتعيين مفتاح كـ مفتاح اختبار لإنشاء بيئة تجريبية على نفس عنوان URL الأساسي - لا حاجة لبيئة أو بيانات اعتماد منفصلة. يتم وسم البيانات المكتوبة به (الأعضاء، الطلبات، القسائم) وإخفاؤها عن قوائمك ولوحات معلوماتك الفعلية؛ لا يتم التواصل مع عضو الاختبار فعليًا (يتم تعطيل رسائل البريد الإلكتروني التسويقية والرسائل النصية القصيرة والإشعارات الفورية) ولا يتم استرداد قسيمة الاختبار أبدًا بقيمة حقيقية؛ ويؤدي استخدام POST /api/v2/test-data/purge مرة واحدة إلى مسح كل شيء. جرب بحرية، ثم أعد التعيين.

مرجع

نقاط النهاية

71 نقاط النهاية عبر 19 مجموعات الموارد. الطريقة والمسار وملخص من سطر واحد لكل منها - تفاصيل المعلمات والمخطط الكاملة موجودة في OpenAPI JSON.

CWM التوقعات

4 نقطة النهاية s

CWMتوزيع الحدث التالي النهائي الوحيد، TimesFM 2.5 توقعات الطلب ونوافذ دمج المستأجرين والقطاع الخاص. تتطلب السلوكيات التالية predictions:readتتطلب الاتجاهات/النوافذ أيضًا metrics:readاحتمالات الحدث التالي غير مُعايرة وتعتمد على الأهداف المدعومة؛ وتبقى نوافذ الاندماج null إلى حين التدريب والتحقق من صحة البيانات.

GET/api/v2/cwm/capabilities
GET/api/v2/cwm/members/{id}/next-behaviors
GET/api/v2/cwm/trends
GET/api/v2/cwm/members/{id}/purchase-windows

المتاجر

4 نقطة النهاية s

إدارة المتجر

GET/api/v2/stores
GET/api/v2/stores/{id}
POST/api/v2/stores
PUT/api/v2/stores/{id}

الأعضاء

12 نقطة النهاية s

إدارة أعضاء برنامج الولاء

GET/api/v2/members
POST/api/v2/members
POST/api/v2/members/batch
GET/api/v2/members/{id}
تحديث/api/v2/members/{id}
GET/api/v2/members/{id}/points
POST/api/v2/members/{id}/points
GET/api/v2/members/{id}/tier
GET/api/v2/members/{id}/coupons
GET/api/v2/members/{id}/receipts
GET/api/v2/members/{id}/profile
POST/api/v2/members/{id}/redeem-coupon

الطلبات

4 نقطة النهاية s

استلام الطلبات ← منح النقاط تلقائيًا، واسترداد الأموال، والتسوية

GET/api/v2/orders
POST/api/v2/orders
POST/api/v2/orders/batch
POST/api/v2/orders/{externalOrderId}/refund

الكتالوج

5 نقطة النهاية s

كتالوج المنتجات (PIM) - المنتجات، والأنواع، والفئات، والعلامات التجارية؛ استيراد من نظام تخطيط موارد المؤسسات (ERP)/Shopify

GET/api/v2/products
GET/api/v2/products/{id}
GET/api/v2/categories
GET/api/v2/brands
POST/api/v2/catalog/import

وسوم الأعضاء

4 نقطة النهاية s

اطلع على دليل العلامات - دورة الحياة، وRFM، ومستوى القيمة، والتفاعل، وتوقيت الشراء، والتفضيل (بما في ذلك الانتماء للفئة)، والمخاطر، والموافقة، ومحاور القنوات - وقم بتعيين/إزالة علامات العضو يدويًا.

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
حذف/api/v2/members/{id}/tags/{tagKey}

حقول مخصصة

2 نقطة النهاية s

قراءة الحقول المخصصة المُعرّفة من قِبل المستأجر لأي كيان (عضو / متجر / منتج / مجموعة قسائم / طلب). للقراءة فقط؛ غير حساسة بطبيعتها. النطاق: custom_fields:read.

GET/api/v2/custom-fields
GET/api/v2/custom-fields/values

التقاط البيانات

1 نقطة النهاية

التقاط السجلات

GET/api/v2/captures

قسائم شرائية

4 نقطة النهاية s

مجموعات القسائم، والرموز، والاسترداد

GET/api/v2/coupons
GET/api/v2/coupons/pools
POST/api/v2/coupons/issue
POST/api/v2/coupons/{id}/redeem

السفير

3 نقطة النهاية s

برنامج السفراء - المرشحون، تقرير عائد الاستثمار، ورموز التسويق بالعمولة

GET/api/v2/ambassador/candidates
GET/api/v2/ambassador/metrics
POST/api/v2/ambassador/members/{id}/issue-code

التتبع

2 نقطة النهاية s

تحليلات زيارات الصفحات وسلوك المستخدمين واستيعاب الأحداث

GET/api/v2/tracking/stats
POST/api/v2/tracking/events

API المفاتيح

3 نقطة النهاية s

API إدارة المفاتيح

GET/api/v2/api-keys
POST/api/v2/api-keys
حذف/api/v2/api-keys/{id}

التفويض

7 نقطة النهاية s

المصادقة وملف تعريف المستخدم

POST/api/v2/auth/register
POST/api/v2/auth/login
GET/api/v2/auth/profile
تحديث/api/v2/auth/profile
POST/api/v2/auth/change-password
POST/api/v2/auth/forgot-password
POST/api/v2/auth/reset-password

القطاعات

5 نقطة النهاية s

شرائح الجمهور - شروط مُهيكلة تُستخدم لاستهداف الحملات

GET/api/v2/segments
POST/api/v2/segments
GET/api/v2/segments/{id}
تحديث/api/v2/segments/{id}
حذف/api/v2/segments/{id}

الحملات التسويقية

3 نقطة النهاية s

الحملات - إنشاء قوائم ومسودات (لا تُرسل أبدًا؛ يراجعها شخص بشري ثم يرسلها).

GET/api/v2/campaigns
POST/api/v2/campaigns
GET/api/v2/campaigns/{id}

الأتمتة

2 نقطة النهاية s

الأتمتة — سرد التدفقات المُفعّلة بالأحداث وإيقافها مؤقتًا/استئنافها

GET/api/v2/automations
تحديث/api/v2/automations/{id}

معاملة تجارية

1 نقطة النهاية

إرسال المعاملات — يقوم نظامك بإرسال حملة إلى مستلم واحد، وقد فعّلها المستخدم صراحةً للاستخدام في المعاملات (تأكيدات الطلبات، الإيصالات). لا يقوم API بإنشاء المحتوى أبدًا؛ ويتم دائمًا احترام قيود إمكانية التسليم. مرر مفتاح idempotency_key لجعل إعادة المحاولات آمنة

POST/api/v2/transactional/send

الواردات

4 نقطة النهاية s

استيراد جماعي غير متزامن - تحميل ملف CSV/JSONL للأعضاء/الطلبات واستطلاع المهمة (بدون حد أقصى ١٠٠ صف)

POST/api/v2/members/import
GET/api/v2/members/import/{id}
POST/api/v2/orders/import
GET/api/v2/orders/import/{id}

بيانات الاختبار

1 نقطة النهاية

بيانات وضع الاختبار في بيئة الاختبار المعزولة - حذف كل ما أنشأه مفتاح الاختبار

POST/api/v2/test-data/purge
تم الشحن مؤخرًا

حقول الملف الشخصي التنبؤية وتوصيات أكثر ذكاءً

تحديثان يتمّان داخل نقاط النهاية الحالية - لا توجد واجهة عامة جديدة، وتبقى استجابات نقاط نهاية التوصيات الحالية دون تغيير.

GET /api/v2/members/{id}/profile

تتضمن الآن عمليات تجميع الملفات الشخصية الحقول التنبؤية، والتي يتم حسابها عندما تدعم بيانات الفريق التوافق:

  • تاريخ الطلب التالي المتوقع - نموذج جاما مُلائم لكل عضو بناءً على فترات الشراء الخاصة به (يتطلب 3 عمليات شراء أو أكثر)، ويُعاد مع إحصائيات الفترات ومؤشر الثقة.
  • احتمالية النقر على البريد الإلكتروني - إحصائية لوجستية مُنظَّمة من المستوى الثاني لكل فريق P(click) من ميزات التفاعل التجميعية للملف الشخصي.

كلا الحقلين null يقعان أسفل بوابات الصدق - لا مجال للتخمين. يجب على المستهلكين التعامل مع null.

Recommendations (public embed + v2)

تم تحديث نظام تقييم الشراء المشترك إلى مقياس تشابه المنتجات المُعدَّل بجيب التمام، بحيث لم يعد تأثير المنتجات الأكثر مبيعًا هو العامل الحاسم في قوة الشراء المشترك.

score = co_count / sqrt(buyers(A) × buyers(B))   # pairs need ≥2 shared buyers
                                                 # raw co_count still stored

يتم تشغيل مهمة جديدة ليلية لكل فريق (الدعم / الثقة / الرفع؛ MIN_PAIR_ORDERS=3، MIN_CONFIDENCE=0.05، أفضل 25 قاعدة لكل سابقة حسب الرفع) وتُقدّم اقتراحات البيع المتبادل. تستمر عمليات التكامل الحالية بالعمل كما هي - أشكال الاستجابة لم تتغير.