Door/Gate Controller अनलॉक करें

Door/Gate Controller को अनलॉक कमांड भेजता है और भौतिक रिले द्वारा अनलॉक होने की पुष्टि की प्रतीक्षा करता है।

इस एंडपॉइंट को कॉल करने से पहले आपके सिस्टम को तय करना होगा कि व्यक्ति अधिकृत है या नहीं। Performance Hub केवल पार्टनर कुंजी, सुविधा पहुँच, दरवाज़े के स्वामित्व और डिवाइस की स्थिति को सत्यापित करता है।

पैरामीटर

door_id string आवश्यक

सूची एंडपॉइंट द्वारा लौटाया गया Door/Gate Controller ID।
facility_id string इनमें से एकअपने इंटीग्रेशन के लिए कॉन्फ़िगर किया गया सुविधा पहचानकर्ता प्रकार दें: डायरेक्ट-लिंक इंटीग्रेशन के लिए facility_id का उपयोग करें, या लिंकिंग-आइडेंटिफ़ायर इंटीग्रेशन के लिए linking_identifier का उपयोग करें। दोनों न भेजें; API आपके पार्टनर खाते के लिए कॉन्फ़िगर किए गए पहचानकर्ता प्रकार का उपयोग करता है और दूसरे को अनदेखा करता है। और जानें

Performance Hub सुविधा ID। डायरेक्ट-लिंक इंटीग्रेशन के लिए आवश्यक।
linking_identifier string इनमें से एकअपने इंटीग्रेशन के लिए कॉन्फ़िगर किया गया सुविधा पहचानकर्ता प्रकार दें: डायरेक्ट-लिंक इंटीग्रेशन के लिए facility_id का उपयोग करें, या लिंकिंग-आइडेंटिफ़ायर इंटीग्रेशन के लिए linking_identifier का उपयोग करें। दोनों न भेजें; API आपके पार्टनर खाते के लिए कॉन्फ़िगर किए गए पहचानकर्ता प्रकार का उपयोग करता है और दूसरे को अनदेखा करता है। और जानें

पार्टनर सुविधा पहचानकर्ता। लिंकिंग-आइडेंटिफ़ायर इंटीग्रेशन के लिए आवश्यक।
member_id string आवश्यक

पार्टनर सदस्य ID। इसका उपयोग ऑडिट लॉगिंग और बाद में डेटा लिंकिंग के लिए किया जाता है।
first_name string आवश्यक

दरवाज़ा खोलने वाले व्यक्ति का पहला नाम।
last_name string आवश्यक

दरवाज़ा खोलने वाले व्यक्ति का अंतिम नाम।
full_name string वैकल्पिक

वैकल्पिक। यदि छोड़ दिया जाए, तो Performance Hub first_name और last_name को जोड़ देता है।
check_in_id string वैकल्पिक

सहसंबंध के लिए आपके सिस्टम से वैकल्पिक चेक-इन ID।
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"
}