ドア/ゲートコントローラーを解錠する

ドア/ゲートコントローラーに解錠コマンドを送信し、物理リレーが解錠を確認するまで待機します。

このエンドポイントを呼び出す前に、人物が許可されているかどうかをお使いのシステムで判断する必要があります。Performance Hub が確認するのは、パートナーキー、施設へのアクセス、ドアの所有関係、デバイスの状態のみです。

パラメーター

door_id string 必須

一覧エンドポイントから返されたドア/ゲートコントローラーの ID。
facility_id string いずれか一方連携に設定されている施設識別子の種類を指定してください。Direct Link の連携では facility_id を、Linking Identifier の連携では linking_identifier を使用します。両方を送信しないでください。API はパートナーアカウントに設定された識別子の種類を使用し、もう一方は無視します。詳細

Performance Hub の施設 ID。Direct Link の連携で必須です。
linking_identifier string いずれか一方連携に設定されている施設識別子の種類を指定してください。Direct Link の連携では facility_id を、Linking Identifier の連携では linking_identifier を使用します。両方を送信しないでください。API はパートナーアカウントに設定された識別子の種類を使用し、もう一方は無視します。詳細

パートナーの施設識別子。Linking Identifier の連携で必須です。
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 - ドア/ゲートコントローラーがオフラインであるか、情報が古くなっている。
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"
}