פתיחת Door/Gate Controller

שולח פקודת פתיחה ל-Door/Gate Controller וממתין שהממסר הפיזי יאשר שהוא נפתח.

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

פרמטרים

• door_id string חובה

  מזהה ה-Door/Gate Controller שהוחזר מנקודת הקצה של הרשימה.

• facility_id string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

  מזהה המתקן ב-Performance Hub. חובה באינטגרציות מסוג direct-link.

• linking_identifier string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

  מזהה המתקן אצל השותף. חובה באינטגרציות מסוג linking-identifier.

• member_id string חובה

  מזהה החבר אצל השותף. משמש לרישום ביומן הביקורת ולקישור נתונים בהמשך.

• first_name string חובה

  השם הפרטי של האדם שפותח את הדלת.

• last_name string חובה

  שם המשפחה של האדם שפותח את הדלת.

• full_name string אופציונלי

  אופציונלי. אם הוא מושמט, Performance Hub משלב את first_name ו-last_name.

• check_in_id string אופציונלי

  מזהה צ׳ק-אין אופציונלי מהמערכת שלכם, לצורך הצלבה.

• idempotency_key string אופציונלי

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

ערך מוחזר

מחזיר 200 רק כשהמכשיר מאשר שהממסר נפתח פיזית. הדלת משתמשת בזמן ההחזקה שהוגדר בניהול מכשירים ב-Performance Hub; שותפים אינם יכולים לעקוף את תזמון הממסר בכל בקשה. רוב האישורים אמורים להתקבל תוך 3-5 שניות. התייחסו לזמן הקצוב המתועד כפתיחה שנכשלה באופן מפורש, ונסו שוב רק בהתאם לכללי הבטיחות שלכם.

כשלים נפוצים:

• 403 integration_not_enabled - האינטגרציה שלכם אינה מופעלת עבור המתקן.
• 409 maintenance_mode_active - צוות המתקן הפעיל מצב תחזוקה עבור הדלת.
• 503 device_offline - ה-Door/Gate Controller לא מקוון או שהנתונים שלו אינם עדכניים.
• 504 unlock_confirmation_timeout - הפקודה נשלחה, אבל לא התקבל אישור תואם לפני תום הזמן הקצוב.

בקשה

curl -X POST https://partner-api.performancehub.co/partner/v1/access-control/doors/00000000000000000000000000000007/unlock \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "facility_id": "550e8400-e29b-41d4-a716-446655440000",
    "member_id": "mem_12345",
    "first_name": "Jane",
    "last_name": "S.",
    "full_name": "Jane S.",
    "source": "door_reader",
    "idempotency_key": "unlock_20260501_0001"
  }'

תגובה

{
  "status": "unlocked",
  "door_id": "00000000000000000000000000000007",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "event_id": "00000000-0000-0000-0000-000000000045",
  "command_id": "00000000-0000-0000-0000-000000000049",
  "hold_time_seconds": 10,
  "confirmed_at": "2026-05-01T04:30:00.000Z"
}

תגובת כשל

{
  "status": "failed",
  "reason": "device_offline",
  "door_id": "00000000000000000000000000000007",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "event_id": "00000000-0000-0000-0000-000000000045"
}