שיטות קישור של שותפים

שותפים או מערכות שונות לניהול חברים מזהים כל מתקן או מיקום לפי מזהה משלהם, כגון מזהה סניף, מספר חנות או מזהה מתקן. יש לנו שני סוגים של דרכים לזהות מיקומים במהלך סנכרון נתונים או דחיפתם.

1. קישור ישיר

בעת דחיפת נתונים, השותף ישתמש במזהה המתקן ממערכת Performance Hub.

לדוגמה, אצל שותף A, המזהה הפנימי של מתקן בטוקיו הוא branch_tokyo. אבל כדי לנרמל את הנתונים בתוך המערכת האקולוגית של Performance Hub, אנחנו מקצים מזהה חדש למיקום הזה ולשותף הזה, לדוגמה UUID: 550e8400-e29b-41d4-a716-446655440000.

על השותפים להשתמש ב-facility_id הזה בעת קריאה ל-API שלנו לדחיפת נתונים.

כדי לקבל את ה-facility_id הנכון לקישור (כנדרש בשיטת Direct Link), שותפים יכולים לקרוא לנקודת הקצה /partner/v1/facilities של ה-API. נקודת קצה זו מחזירה רשימה של כל המתקנים שבהם אינטגרציית השותף שלכם מופעלת כעת ב-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"
      }
    ]
  }'