Bir Door/Gate Controller'ın kilidini açma

Door/Gate Controller'a bir kilit açma komutu gönderir ve fiziksel rölenin kilidin açıldığını onaylamasını bekler.

Sisteminiz bu uç noktayı çağırmadan önce kişinin yetkili olup olmadığına karar vermelidir. Performance Hub yalnızca iş ortağı anahtarını, tesis erişimini, kapı sahipliğini ve cihaz durumunu doğrular.

Parametreler

  • door_id string zorunlu

    Liste uç noktasının döndürdüğü Door/Gate Controller kimliği.

  • facility_id string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    Performance Hub tesis kimliği. Doğrudan bağlantı entegrasyonları için zorunludur.

  • linking_identifier string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    İş ortağı tesis tanımlayıcısı. Bağlama tanımlayıcısı entegrasyonları için zorunludur.

  • member_id string zorunlu

    İş ortağı üye kimliği. Denetim kaydı ve sonraki veri bağlama için kullanılır.

  • first_name string zorunlu

    Kapıyı açan kişinin adı.

  • last_name string zorunlu

    Kapıyı açan kişinin soyadı.

  • full_name string isteğe bağlı

    İsteğe bağlı. Belirtilmezse Performance Hub first_name ve last_name değerlerini birleştirir.

  • check_in_id string isteğe bağlı

    İlişkilendirme için sisteminizden isteğe bağlı check-in kimliği.

  • idempotency_key string isteğe bağlı

    İsteğe bağlı yeniden oynatma koruması anahtarı. Aynı iş ortağı, tesis ve kapı için aynı anahtarı yeniden kullanmak, varsa mevcut sonucu döndürür.

Döndürülen değer

Yalnızca cihaz rölenin fiziksel olarak kilidinin açıldığını onayladığında 200 döndürür. Kapı, Performance Hub Aygıt Yönetimi'nde yapılandırılan açık tutma süresini kullanır; iş ortakları röle zamanlamasını istek bazında geçersiz kılamaz. Onayların çoğu 3-5 saniye içinde tamamlanmalıdır. Belgelenen zaman aşımını açık bir başarısız kilit açma olarak değerlendirin ve yalnızca kendi güvenlik kurallarınıza göre yeniden deneyin.

Yaygın hatalar:

  • 403 integration_not_enabled - entegrasyonunuz tesis için etkin değil.
  • 409 maintenance_mode_active - tesis personeli kapı için bakım modunu etkinleştirmiş.
  • 503 device_offline - Door/Gate Controller çevrimdışı veya güncel değil.
  • 504 unlock_confirmation_timeout - komut gönderildi ancak zaman aşımından önce eşleşen bir onay alınamadı.

İstek

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"
  }'

Yanıt

{
  "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"
}

Hata yanıtı

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