Een Door/Gate Controller ontgrendelen

Stuurt een ontgrendelopdracht naar de Door/Gate Controller en wacht tot het fysieke relais bevestigt dat het is ontgrendeld.

Je systeem moet beslissen of de persoon toegang heeft voordat dit endpoint wordt aangeroepen. Performance Hub controleert alleen de partnersleutel, de toegang tot de faciliteit, het eigendom van de deur en de status van het apparaat.

Parameters

door_id string verplicht

ID van de Door/Gate Controller dat door het list-endpoint wordt geretourneerd.
facility_id string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

Faciliteit-ID in Performance Hub. Verplicht voor integraties met Direct Link.
linking_identifier string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

Faciliteitidentificatie van de partner. Verplicht voor integraties met een Linking Identifier.
member_id string verplicht

Lid-ID van de partner. Wordt gebruikt voor auditlogboeken en latere koppeling van gegevens.
first_name string verplicht

Voornaam van de persoon die de deur opent.
last_name string verplicht

Achternaam van de persoon die de deur opent.
full_name string optioneel

Optioneel. Als dit wordt weggelaten, combineert Performance Hub first_name en last_name.
check_in_id string optioneel

Optioneel check-in-ID uit je systeem om gegevens aan elkaar te koppelen.
idempotency_key string optioneel

Optionele sleutel ter bescherming tegen herhaling. Als je dezelfde sleutel opnieuw gebruikt voor dezelfde partner, faciliteit en deur, wordt het bestaande resultaat geretourneerd wanneer dat beschikbaar is.

Retourwaarde

Retourneert alleen 200 wanneer het apparaat bevestigt dat het relais fysiek is ontgrendeld. De deur gebruikt de openhoudtijd die in Apparaatbeheer van Performance Hub is geconfigureerd; partners kunnen de relaistiming niet per verzoek overschrijven. De meeste bevestigingen zijn binnen 3-5 seconden binnen. Behandel de gedocumenteerde time-out als een expliciet mislukte ontgrendeling en probeer het alleen opnieuw volgens je eigen veiligheidsregels.

Veelvoorkomende fouten:

403 integration_not_enabled - je integratie is niet ingeschakeld voor de faciliteit.
409 maintenance_mode_active - medewerkers van de faciliteit hebben de onderhoudsmodus voor de deur ingeschakeld.
503 device_offline - de Door/Gate Controller is offline of niet actueel.
504 unlock_confirmation_timeout - de opdracht is verzonden, maar er is vóór de time-out geen bijbehorende bevestiging ontvangen.

Verzoek

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

Respons

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

Response bij een fout

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