מסוף שותפים

ה-Partner Console מספק ממשק אינטרנטי לניהול האינטגרציה שלכם עם Performance Hub.

אם עדיין אין לכם גישה ל-Partner Console, פנו אלינו על ידי שליחת פניית שותף דרך האתר הראשי של Performance Hub. הצוות שלנו ילווה אתכם בתהליך ההצטרפות של שותפים ויעזור להגדיר את הגישה שלכם ל-Console.

גישה ל-Console

כדי לגשת ל-Partner Console, תצטרכו:

Partner ID - מזהה ייחודי ש-Performance Hub מספק לכל שותף
One-Time Password (OTP) - קוד אימות שנשלח לכתובת ה-Partner Email שלכם

התחברו בכתובת partner-api.performancehub.co/partner/v1/console

מה יש ב-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, מספר חנות וכו')
- מידע נוסף על שיטות הקישור של שותפים
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.

לדוגמה, אצל שותף 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 המתאימים שלהם.

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), שמציגה את מזהה הקישור / המזהה הפנימי ממערכת ניהול החברים, כפי שהוגדר במסך אינטגרציות השותפים

דוגמה: 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"
      }
    ]
  }'

דוגמה: 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"
      }
    ]
  }'