وحدة تحكم الشريك

توفّر Partner Console واجهة ويب لإدارة تكاملك مع Performance Hub.

إذا لم تكن لديك بعدُ إمكانية الوصول إلى Partner Console، فيُرجى التواصل معنا بإرسال استفسار شراكة عبر الموقع الرئيسي لـ Performance Hub. سيرشدك فريقنا خلال عملية انضمام الشركاء ويساعدك في إعداد إمكانية الوصول إلى وحدة التحكم.

الوصول إلى وحدة التحكم

للوصول إلى Partner Console، ستحتاج إلى ما يلي:

1. Partner ID - معرّف فريد يوفّره Performance Hub لكل شريك
2. One-Time Password (OTP) - رمز تحقق يُرسل إلى Partner Email الخاص بك

سجّل الدخول على partner-api.performancehub.co/partner/v1/console

محتويات وحدة التحكم

توفّر Partner Console أدوات لإدارة تكاملك مع Performance Hub:

• Secret Keys - أنشئ مفاتيح API بمستويات وصول مختلفة (live وdryrun وread-only) وأدرها
• Integration Settings - هيّئ طريقة ربط تكاملك بالمنشآت
• Partner Details - اعرض معلومات ملفك التعريفي كشريك وحدّثها
• Logs - راقب نشاط API واستكشف المشكلات وأصلحها
• Connected Organisations - اطّلع على جميع المنظمات التي تستخدم تكاملك
• Ask AI - احصل على مساعدة فورية باستخدام الاختصار ⌘I

للحصول على معلومات تفصيلية حول كل ميزة، راجع ميزات Partner Console.

ميزات Partner Console

تتضمن Partner Console أربعة أقسام رئيسية يمكن الوصول إليها من علامات تبويب التنقل:

1. المفاتيح السرية

أدر مفاتيح API السرية الخاصة بك مع تحكم كامل في أنواع الوصول والأذونات.

الميزات الرئيسية:

• Create New Keys - أنشئ مفاتيح API جديدة بمستويات وصول محددة
• Key Types:
  • Live - وصول كامل للقراءة والكتابة إلى بيانات الإنتاج
  • Dryrun - اختبر عمليات الكتابة دون التأثير في بيانات الإنتاج (تتم محاكاة عمليات الكتابة)
  • Read-only - وصول للقراءة فقط لاستهلاك البيانات بأمان (عمليات الكتابة محظورة)
• Key Management - اعرض تفاصيل المفاتيح وآخر أوقات استخدامها، وبدّل المفاتيح، وألغِها فورًا
• Key Filtering - صفِّ المفاتيح حسب الحالة (All وActive وRevoked)
• Key Rotation - بدّل المفاتيح بسلاسة دون أي توقف عن العمل

يعرض كل مفتاح سري ما يلي:

• Label - اسم قابل للتخصيص لتسهيل التعرّف عليه
• Key ID - معرّف فريد (بتنسيق UUID)
• Secret - المفتاح السري محجوب جزئيًا (تظهر أول 12 حرفًا وآخر 4 أحرف)
• Type - مستوى وصول المفتاح (live وdryrun وread-only)
• Status - الحالة الحالية (active وrevoked)
• Created - تاريخ إنشاء المفتاح
• Last Used - الطابع الزمني لأحدث استدعاء API
• Actions - تبديل المفتاح أو إلغاؤه

2. إعدادات التكامل

هيّئ طريقة ربط تكاملك بمنشآت Performance Hub.

الميزات الرئيسية:

• Data Linking Method - اختر بين طريقتَي ربط:
  • Direct Link - استخدم معرّفات المنشآت في Performance Hub في استدعاءات API
  • Linking Identifier - استخدم معرّفات المواقع الخاصة بك (Branch ID وStore Number وغيرها)
  • اعرف المزيد عن طرق ربط الشركاء
• Linking Identifier Label - خصّص اسم الحقل المعروض للمنشآت (مثل "Branch ID" و"Location Code")
• Partner Prefix - عيّن بادئة فريدة لتكاملاتك
• Integration Fields - هيّئ حقولًا مخصصة خاصة بتكاملك

3. تفاصيل الشريك

اعرض معلومات ملفك التعريفي كشريك وأدرها.

الحقول القابلة للتعديل:

• Partner Email - البريد الإلكتروني الأساسي لجهة الاتصال لتلقي الإشعارات
• Description - وصف موجز لتكاملك
• Logo URL - عنوان URL لشعار الشريك الخاص بك
• Website - موقع شركتك أو موقع التكامل
• Category - تصنيف فئة التكامل
• Details - معلومات إضافية عن الشريك

معلومات للقراءة فقط:

• Partner ID (معرّف فريد)
• اسم الشريك
• حالة التكامل
• عدد المنظمات المتصلة

4. السجلات

راقب نشاط API واستكشف مشكلات التكامل وأصلحها.

البيانات المتاحة:

• سجلات طلبات API
• رموز حالة الاستجابة
• رسائل الخطأ
• معلومات الطوابع الزمنية
• حمولات الطلبات/الاستجابات

المنظمات المتصلة

اعرض جميع المنظمات التي فعّلت تكاملك. تعرض بطاقة كل منظمة ما يلي:

• اسم المنظمة
• العلامات التجارية المرتبطة
• عدد المنشآت النشطة
• حالة التكامل

Ask AI

احصل على مساعدة فورية في الموضوعات المتعلقة بالشركاء باستخدام مساعد الذكاء الاصطناعي (الاختصار ⌘I).

اسأل عن:

• استخدام نقاط نهاية API وأمثلة عليها
• المصادقة وإدارة المفاتيح السرية
• أفضل ممارسات مزامنة البيانات
• استكشاف مشكلات التكامل الشائعة وإصلاحها
• ميزات Partner Console والتنقل فيها

طرق ربط الشركاء

يحدد الشركاء أو أنظمة إدارة الأعضاء المختلفة كل منشأة أو موقع بمعرّف خاص بها، مثل معرّف الفرع أو رقم المتجر أو معرّف المنشأة. ولدينا طريقتان لتحديد المواقع أثناء مزامنة البيانات أو إرسالها.

1. الارتباط المباشر

عند إرسال البيانات، يستخدم الشريك معرّف المنشأة من نظام Performance Hub.

على سبيل المثال، المعرّف الداخلي لدى Partner A لمنشأة في طوكيو هو branch_tokyo. ولكن لتوحيد البيانات داخل منظومة Performance Hub، نعيّن معرّفًا جديدًا لهذا الموقع ولهذا الشريك، على سبيل المثال UUID: 550e8400-e29b-41d4-a716-446655440000.

يجب على الشركاء استخدام facility_id هذا عند استدعاء واجهات API الخاصة بنا لإرسال البيانات.

للحصول على facility_id الصحيح للربط (كما هو مطلوب في طريقة Direct Link)، يمكن للشركاء استدعاء نقطة نهاية API /partner/v1/facilities. تُرجع نقطة النهاية هذه قائمة بجميع المنشآت التي فعّلت تكامل الشريك الخاص بك حاليًا في Performance Hub، مع قيم facility_id المقابلة لها.

2. معرف الارتباط

يحتفظ الشريك بنظامه الخاص الذي يتضمن معرّفات فريدة لكل موقع (مثل "Branch ID" و"Location Code" و"Store Number"). تتيح طريقة الربط هذه للشريك تحديد منشآت Performance Hub باستخدام معرّفه الخاص بدلًا من معرّف المنشأة لدينا.

إعداد المنشأة: عندما تفعّل منشأة هذا الشريك، يُطلب منها تقديم المعرّف الفريد الذي يستخدمه الشريك لتحديد موقعها، وذلك ضمن تهيئة المنشأة في Performance Hub.

تكامل API: عندما يُجري الشريك استدعاءات API إلى Performance Hub، يمكنه تقديم معرّفه الفريد الخاص في الطلب. ويبحث Performance Hub داخليًا عن linking_identifier لمطابقة استدعاء API مع المنشأة الصحيحة.

مثال: إذا كان الشريك يسمّي المواقع "Branch ID" في نظامه، فاضبط التسمية أدناه على "Branch ID". ستقدّم كل منشأة بعد ذلك قيمة Branch ID الخاصة بها عند تفعيل التكامل، ما يتيح مزامنة سلسة للبيانات بين الأنظمة.

مثال على تهيئة من شاشة تكاملات المنشأة (العرض الرئيسي للمنشأة في Performance Hub) يوضح معرّف الربط / المعرّف الداخلي من نظام إدارة الأعضاء المهيّأ في شاشة تكاملات الشركاء

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "facility_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "linking_identifier": "branch_tokyo",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'