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

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

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 المقابلة لها.

مثال: Direct Link

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"
      }
    ]
  }'

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) يوضح معرّف الربط / المعرّف الداخلي من نظام إدارة الأعضاء المهيّأ في شاشة تكاملات الشركاء

مثال: Linking Identifier

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"
      }
    ]
  }'