API Documentation - EntryZen Gate Simulator

Command API

POST /api/command.php

Trigger gate actions from external systems. Use this endpoint to open, close, or toggle gates.

Request Body

Parameter	Type	Description
device_id required	string	The 6-character device ID of the gate
command required	string	One of: `open`, `close`, `toggle`

Response

                        {
  "success": true,
  "device_id": "A1B2C3",
  "position": "opening",
  "auto_close_in": 32
}
                    

Code Examples

                            curl -X POST /api/command.php \
  -H "Content-Type: application/json" \
  -d '{"device_id": "A1B2C3", "command": "open"}'
                        

                            import requests

response = requests.post(
    "/api/command.php",
    json={"device_id": "A1B2C3", "command": "open"}
)

result = response.json()
print(f"Gate is now {result['position']}")
                        

                            fetch('/api/command.php', {
    method: 'POST',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({
        device_id: 'A1B2C3',
        command: 'open'
    })
})
.then(res => res.json())
.then(data => console.log('Gate is now:', data.position));
                        

                            <?php
$ch = curl_init('/api/command.php');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode([
        'device_id' => 'A1B2C3',
        'command' => 'open'
    ])
]);

$response = curl_exec($ch);
$result = json_decode($response, true);
echo "Gate is now: " . $result['position'];
                        

Try It

Device ID

Command

Status API

POST /api/status.php

Query the current status of a gate. Returns position, online status, and configuration.

Request Body

Parameter	Type	Description
device_id required	string	The 6-character device ID of the gate

Response

                        {
  "device_id": "A1B2C3",
  "name": "Main Entrance",
  "gate_type": "double_leaf",
  "online": true,
  "position": "closed",
  "auto_close_in": null,
  "auto_close_time": 30,
  "guard_hut": true,
  "last_command": "2026-01-29T10:30:00+00:00"
}
                    

Position Values

Value	Description
`closed`	Gate is fully closed
`opening`	Gate is in the process of opening
`open`	Gate is fully open
`closing`	Gate is in the process of closing

Code Examples

                            curl -X POST /api/status.php \
  -H "Content-Type: application/json" \
  -d '{"device_id": "A1B2C3"}'
                        

                            import requests

response = requests.post(
    "/api/status.php",
    json={"device_id": "A1B2C3"}
)

status = response.json()
print(f"Gate '{status['name']}' is {status['position']}")
print(f"Online: {status['online']}")
                        

                            fetch('/api/status.php', {
    method: 'POST',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify({device_id: 'A1B2C3'})
})
.then(res => res.json())
.then(status => {
    console.log(`Gate '${status.name}' is ${status.position}`);
    console.log(`Online: ${status.online}`);
});
                        

Try It

Device ID

Error Responses

All endpoints return errors in the following format:

                        {
  "error": true,
  "message": "Description of the error"
}
                    

Common Error Codes

HTTP Status	Description
`400`	Bad Request - Missing or invalid parameters
`404`	Not Found - Device ID does not exist
`405`	Method Not Allowed - Wrong HTTP method
`503`	Service Unavailable - Gate is offline

Available Gates

These are the currently configured gates in the simulator:

Loading gates...