Otwieranie kontrolera drzwi/bramy

Wysyła polecenie otwarcia do kontrolera drzwi/bramy i czeka, aż fizyczny przekaźnik potwierdzi zwolnienie zamka.

Przed wywołaniem tego punktu końcowego Twój system musi zdecydować, czy dana osoba ma uprawnienia. Performance Hub sprawdza wyłącznie klucz partnera, dostęp do obiektu, przynależność drzwi i stan urządzenia.

Parametry

door_id string wymagany

Identyfikator kontrolera drzwi/bramy zwrócony przez punkt końcowy listy.
facility_id string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

Identyfikator obiektu w Performance Hub. Wymagany w przypadku integracji z bezpośrednim łączeniem.
linking_identifier string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

Identyfikator obiektu partnera. Wymagany w przypadku integracji z identyfikatorem łączącym.
member_id string wymagany

Identyfikator członka u partnera. Służy do rejestrowania na potrzeby audytu i późniejszego łączenia danych.
first_name string wymagany

Imię osoby otwierającej drzwi.
last_name string wymagany

Nazwisko osoby otwierającej drzwi.
full_name string opcjonalny

Opcjonalne. Jeśli zostanie pominięte, Performance Hub połączy first_name i last_name.
check_in_id string opcjonalny

Opcjonalny identyfikator wejścia z Twojego systemu, służący do powiązania danych.
idempotency_key string opcjonalny

Opcjonalny klucz chroniący przed ponownym odtworzeniem. Ponowne użycie tego samego klucza dla tego samego partnera, obiektu i drzwi zwraca istniejący wynik, jeśli jest dostępny.

Zwracane wartości

Zwraca 200 tylko wtedy, gdy urządzenie potwierdzi, że przekaźnik fizycznie zwolnił zamek. Drzwi pozostają otwarte przez czas skonfigurowany w module Zarządzanie urządzeniami Performance Hub; partnerzy nie mogą zmieniać czasu działania przekaźnika w poszczególnych żądaniach. Większość potwierdzeń powinna nastąpić w ciągu 3-5 sekund. Traktuj przekroczenie udokumentowanego limitu czasu jako jednoznacznie nieudane otwarcie i ponawiaj próbę wyłącznie zgodnie z własnymi zasadami bezpieczeństwa.

Typowe błędy:

403 integration_not_enabled — Twoja integracja nie jest włączona dla obiektu.
409 maintenance_mode_active — personel obiektu włączył tryb serwisowy dla drzwi.
503 device_offline — kontroler drzwi/bramy jest offline lub jego dane są nieaktualne.
504 unlock_confirmation_timeout — polecenie zostało wysłane, ale przed upływem limitu czasu nie otrzymano pasującego potwierdzenia.

Żądanie

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

Odpowiedź

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

Odpowiedź z błędem

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