תיעוד ניסיון גישה או דחייה

מתעד ניסיון גישה או דחייה שהמערכת שלכם כבר החליטה עליהם. אין פנייה ל-Door/Gate Controller, והדלת אינה נפתחת.

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

אירוע דחייה מופיע ביומני הגישה של Door & Gate Access עם התוצאה Denied, שם השותף שלכם, הדלת, מזהה החבר כשאתם שולחים אותו וקוד הסיבה בצורה קריאה. לדוגמה, membership_expired מוצג כ-"Membership Expired". reason_display_text ו-user_email נשמרים עם האירוע.

פרמטרים

  • 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.

  • outcome string חובה

    denied או attempted.

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

    קוד סיבה באותיות קטנות בפורמט snake_case, עד 64 תווים. חובה כאשר outcome הוא denied. דוגמה: membership_expired.

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

    סיבה קריאה לבני אדם, עד 256 תווים. דוגמה: Membership expired on 2026-04-01.

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

    מזהה החבר אצל השותף. השמיטו אותו כשפרטי הזיהוי לא התאימו לאף חבר, למשל כרטיס לא מוכר.

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

    כתובת הדוא"ל של האדם שניסה לקבל גישה.

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

    מתי התרחש הניסיון, בפורמט ISO 8601 עם אזור זמן. דוגמה: 2026-05-18T10:15:30Z. ברירת המחדל היא השעה שבה הבקשה מתקבלת. אסור שיהיה יותר מ-5 דקות בעתיד או ישן מ-30 ימים.

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

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

ערך מוחזר

מחזיר 201 כשהאירוע מתועד. שליחה חוזרת של אותו idempotency_key מחזירה 200 כאשר idempotent מוגדר ל-true, ואינה יוצרת אירוע נוסף.

מפתח dry-run מחזיר 200 כאשר dry_run מוגדר ל-true. שום דבר אינו מתועד.

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

  • 400 - הגוף אינו תקין, לדחייה אין reason, חותמת הזמן מחוץ לטווח, או ש-facility_id / linking_identifier אינו תואם למתקן מקושר.
  • 403 - המפתח הוא לקריאה בלבד.
  • 403 integration_not_enabled - האינטגרציה שלכם אינה מופעלת עבור המתקן. השדה message מציין את הסיבה.
  • 404 - ה-Door/Gate Controller לא נמצא עבור המתקן המקושר.

בקשה

curl -X POST https://partner-api.performancehub.co/partner/v1/access-control/doors/00000000000000000000000000000007/access-events \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "facility_id": "550e8400-e29b-41d4-a716-446655440000",
    "outcome": "denied",
    "reason": "membership_expired",
    "reason_display_text": "Membership expired on 2026-04-01",
    "member_id": "mem_12345",
    "user_email": "member@example.com",
    "timestamp": "2026-05-18T10:15:30Z",
    "idempotency_key": "evt_abc12345"
  }'

תגובה

{
  "status": "recorded",
  "event_id": "00000000-0000-0000-0000-000000000045",
  "outcome": "denied",
  "door_id": "00000000000000000000000000000007",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2026-05-18T10:15:30.000Z"
}

שליחה חוזרת אידמפוטנטית

{
  "status": "recorded",
  "event_id": "00000000-0000-0000-0000-000000000045",
  "outcome": "denied",
  "door_id": "00000000000000000000000000000007",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2026-05-18T10:15:30.000Z",
  "idempotent": true
}