Controlling Door Lock System in XProtect via REST API

General
1

Hi everyone,

I am trying to enable or send a command to a door lock system in Milestone XProtect using the REST API. However, I couldn’t find a direct REST API endpoint specifically for controlling the door lock system.

I would like to share my proposed approach and get your feedback on whether it is correct.

My idea is to:

  1. Create a User-Defined Event in the Management Client for the door lock system.

  2. Create a Rule that triggers when this event occurs and link the action to the XProtect Access Server to unlock the door.

  3. Trigger this event externally by sending a request through the XProtect Event REST API.

Does this approach make sense, or is there a better or more standard way to control a door lock system via REST API in XProtect?

Additionally, is there any simulation method or testing process available to test door lock functionality without integrating actual door lock hardware?

Any suggestions or documentation references would be greatly appreciated.

Thank you!

3

Your approach makes sense. Since the REST API cannot directly control Access Control items, your workaround is a valid alternative.

The Access Control reference sample, Demo Access Control plug‑in, includes a simulator for an access control system. You can use this simulator when testing the door‑locking functionality you are developing.