{ "info": { "_postman_id": "aiface-device-api-collection", "name": "AiFace Device Web API", "description": "AiFace Facial Recognition Access Control Device - Complete HTTP JSON API Collection\n\n## Usage\n1. Import this collection into Postman\n2. Go to Variables tab (Collection-level Variables)\n3. Set base_url to your device IP (default: http://192.168.1.224)\n4. Set password to your device password (default: 12345678)\n5. All requests will automatically use your configured values\n\n---\n\nProtocol: HTTP + JSON | Base URL: {{base_url}} | Main Endpoint: POST /api | Port: 80 (default) | Auth: All commands require password field except getlang", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "http://192.168.1.224", "type": "string" }, { "key": "password", "value": "12345678", "type": "string" }, { "key": "enrollid", "value": "1001", "type": "string" } ], "item": [ { "name": "7.1 Authentication \u0026 Device Info", "item": [ { "name": "getlang - Get Current Language", "event": [ { "listen": "test", "script": { "exec": [ "// Response check", "if (pm.response.json().result === true) {", " pm.test(\"Language: \" + pm.response.json().lang);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getlang\"\n}" }, "url": "{{base_url}}/api", "description": "No password required. Returns current device language." } }, { "name": "getlangoption - Get Language List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getlangoption\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get available language list enabled in device settings." } }, { "name": "login - Login Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"login\",\n \"username\": \"admin\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Verify admin login credentials." } }, { "name": "reg - Get Full Device Registration Info", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"reg\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Returns complete device info: model, firmware, capacity, network, storage, biometric counts, etc." } }, { "name": "getdevinfo - Get Device Configuration Parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getdevinfo\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Returns all DI_* configuration key-value pairs (network, door, biometric, server settings, etc.)" } }, { "name": "setdevinfo - Set Device Configuration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setdevinfo\",\n \"password\": \"{{password}}\",\n \"nowtime\": 1700000000,\n \"deviceid\": 1,\n \"volume\": 80,\n \"live_detect\": 1,\n \"fcmatch_level\": 60\n}" }, "url": "{{base_url}}/api", "description": "Set any DI_* configuration parameters. Only include fields you want to change. Supports time sync via nowtime (Unix timestamp ms)." } }, { "name": "getdevcap - Get Device Capacity Info", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getdevcap\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Returns max capacities and current usage for users, faces, fingerprints, palms, cards, passwords, logs." } } ] }, { "name": "7.2 User Management", "item": [ { "name": "getuserlist - Get User List (Paginated)", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "pm.test(\u0027User count: \u0027 + json.count, function() { pm.expect(json.result).to.eql(true); });" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getuserlist\",\n \"password\": \"{{password}}\",\n \"stn\": 1\n}" }, "url": "{{base_url}}/api", "description": "Get paginated user list. stn=1 to start from beginning, stn=0 to continue next page. Max 50 records per page." } }, { "name": "getuserids - Get All User IDs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getuserids\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get array of all enrolled user ID strings." } }, { "name": "getunuserdid - Get Next Available User ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getunuserdid\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Returns the next unused user ID for new user enrollment." } }, { "name": "checkuserid - Check If User ID Exists", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"checkuserid\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Check whether a specific user ID exists in the device." } }, { "name": "getuserinfo - Get Single User Details (+Face Photo)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getuserinfo\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"backupnum\": 50\n}" }, "url": "{{base_url}}/api", "description": "Get detailed user info. backupnum=50 includes Base64 face photo. See Appendix for other backupnum values." } }, { "name": "setuserinfo - Add/Update User (+Face)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setuserinfo\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"name\": \"John Doe\",\n \"admin\": 0,\n \"pwd\": 123456,\n \"card\": 12345678,\n \"department\": \"Engineering\",\n \"birthday\": \"01-15\",\n \"starttime\": \"2024-01-01 00:00:00\",\n \"endtime\": \"2025-12-31 23:59:59\",\n \"verifymode\": 0,\n \"shiftid\": 1,\n \"zoneid\": 1,\n \"groupid\": 0,\n \"access_times\": 0,\n \"enable\": 1,\n \"face\": \"\u003cBase64-encoded face JPEG\u003e\"\n}" }, "url": "{{base_url}}/api", "description": "Add new user or update existing user. Include base64 face JPEG in face field for face enrollment. Max 512KB." } }, { "name": "deleteuser - Delete User/Biometric Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteuser\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"backupnum\": 12\n}\n\n/* backupnum action table:\n * 12 or 13 = Delete entire user\n * 0-9 = Delete fingerprint at index\n * 10 = Clear password\n * 11 = Clear card\n * 40/41 = Delete left/right palm print\n * 50/51 = Delete face\n */" }, "url": "{{base_url}}/api", "description": "Delete user or specific biometric data. Use backupnum to select action type." } }, { "name": "deleteuserface - Delete User Face", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteuserface\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Delete face data for a specific user." } }, { "name": "deleteuserfp - Delete All User Fingerprints", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteuserfp\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Delete all fingerprint data for a specific user." } }, { "name": "deleteuserpalm - Delete All User Palm Prints", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteuserpalm\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Delete all palm print data for a specific user." } }, { "name": "deleteusers - Batch Delete Users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteusers\",\n \"password\": \"{{password}}\",\n \"list\": [\"1001\", \"1002\", \"1003\"]\n}" }, "url": "{{base_url}}/api", "description": "Batch delete multiple users by ID array." } }, { "name": "cleanuser - Delete ALL Users [!]", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleanuser\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "[!] DESTRUCTIVE: Removes ALL enrolled users from the device." } }, { "name": "enableuser - Enable/Disable User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"enableuser\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"enflag\": 1\n}\n\n/* enflag: 1 = enable, 0 = disable */" }, "url": "{{base_url}}/api", "description": "Enable (1) or disable (0) a specific user account." } } ] }, { "name": "7.3 Biometric Enrollment (Device-Side)", "item": [ { "name": "adduser - Trigger On-Device Enrollment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"adduser\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"name\": \"John Doe\",\n \"admin\": 0,\n \"backupnum\": 50,\n \"flag\": 0\n}" }, "url": "{{base_url}}/api", "description": "Triggers on-device biometric enrollment screen. Use cancel:true to cancel. Check status with checkregstatus." } }, { "name": "adduser - Cancel Enrollment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"adduser\",\n \"password\": \"{{password}}\",\n \"cancel\": true\n}" }, "url": "{{base_url}}/api", "description": "Cancel an ongoing on-device enrollment process." } }, { "name": "checkregstatus - Query Enrollment Status", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "let statusMap = {\u0027-1\u0027: \u0027Idle/cancelled\u0027, \u00270\u0027: \u0027In progress\u0027, \u00271\u0027: \u0027Success\u0027};", "pm.test(\u0027Status: \u0027 + (statusMap[json.status] || \u0027Failed (\u0027 + json.status + \u0027)\u0027) + \u0027 | Msg: \u0027 + (json.msg || \u0027\u0027));" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"checkregstatus\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Query on-device enrollment status. -1=idle, 0=in progress, 1=success, other=failed." } } ] }, { "name": "7.4 Log Management", "item": [ { "name": "getlog - Get Historical Logs (Paginated)", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "pm.test(\u0027Total logs: \u0027 + json.count + \u0027 | This page: \u0027 + json.from + \u0027-\u0027 + json.to);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getlog\",\n \"password\": \"{{password}}\",\n \"index\": 0,\n \"enrollid\": \"{{enrollid}}\",\n \"from\": \"2024-06-01\",\n \"to\": \"2024-12-31\"\n}" }, "url": "{{base_url}}/api", "description": "Get historical attendance logs with pagination. Filter by user ID and date range (YYYY-MM-DD). Max 50 records/page." } }, { "name": "getrtlog - Get Real-Time Logs", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "pm.test(\u0027RT queue count: \u0027 + json.count + \u0027 | Returned: \u0027 + json.from + \u0027-\u0027 + json.to);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getrtlog\",\n \"password\": \"{{password}}\",\n \"index\": 0\n}" }, "url": "{{base_url}}/api", "description": "Get real-time logs (consumed on read). Up to 20 records/page. Logs are removed from queue after reading." } }, { "name": "setlogs - Mark Logs as Synced", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setlogs\",\n \"password\": \"{{password}}\",\n \"records\": [\n { \"id\": \"1001\", \"event\": 0, \"mode\": 1, \"time\": \"2024-06-01 09:00:00\" }\n ]\n}" }, "url": "{{base_url}}/api", "description": "Mark log records as synced/processed." } }, { "name": "cleanlog - Clear All Logs [!]", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleanlog\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "[!] DESTRUCTIVE: Removes all historical attendance logs." } }, { "name": "cleanlogphoto - Clear All Log Photos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleanlogphoto\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Clear all attendance log snapshot photos." } } ] }, { "name": "7.5 System Management", "item": [ { "name": "gettime - Get Device Time", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\u0027Device time: \u0027 + pm.response.json().time);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"gettime\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get current date/time from the device." } }, { "name": "settime - Set Device Time (String Format)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"settime\",\n \"password\": \"{{password}}\",\n \"cloudtime\": \"2024-06-01 10:00:00\"\n}" }, "url": "{{base_url}}/api", "description": "Sync device time using YYYY-MM-DD HH:MM:SS format." } }, { "name": "settime - Set Device Time (Unix Timestamp)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"settime\",\n \"password\": \"{{password}}\",\n \"nowtime\": 1717200000\n}" }, "url": "{{base_url}}/api", "description": "Sync device time using Unix timestamp in milliseconds." } }, { "name": "reboot - Reboot Device [!]", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"reboot\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "[!] No response - device reboots immediately. HTTP connection will be dropped." } }, { "name": "disabledevice - Pause Recognition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"disabledevice\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Disable face/fingerprint/palm/card recognition on the device." } }, { "name": "enabledevice - Resume Recognition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"enabledevice\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Re-enable face/fingerprint/palm/card recognition on the device." } }, { "name": "initsys - Full System Init [!][!]", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"initsys\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "[!][!] DESTRUCTIVE: Clears ALL users, logs, settings (language preserved), bell schedules, post data, attendance settings, lock data. Backs up WiFi config." } }, { "name": "initmenu - Reset Menu Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"initmenu\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Reset menu/settings to default. Does NOT clear users or logs." } }, { "name": "cleandatebase - Clear Database [!]", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleandatebase\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "[!] Clears database and reboots device." } }, { "name": "setscreensaver - Set Screensaver", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setscreensaver\",\n \"password\": \"{{password}}\",\n \"filename\": \"logo.jpg\",\n \"photo\": \"\u003cBase64 image\u003e\",\n \"duration\": 60,\n \"remove\": false,\n \"removeall\": false\n}" }, "url": "{{base_url}}/api", "description": "Configure screensaver image. Set remove=true to delete specific, removeall=true to clear all." } }, { "name": "upgrade - OTA Firmware Upgrade (Chunked)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"upgrade\",\n \"password\": \"{{password}}\",\n \"filename\": \"ai230_product.zip\",\n \"md5\": \"d41d8cd98f00b204e9800998ecf8427e\",\n \"allcount\": 100,\n \"index\": 0,\n \"count\": 50,\n \"record\": \"\u003cBase64 firmware chunk\u003e\"\n}" }, "url": "{{base_url}}/api", "description": "Upload firmware in chunks. Send repeatedly incrementing index until all chunks uploaded. MD5 verified on last chunk." } }, { "name": "setvoice - Configure Voice Prompt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setvoice\",\n \"password\": \"{{password}}\",\n \"index\": 0,\n \"voice\": \"\u003cBase64 WAV audio\u003e\",\n \"play\": true\n}" }, "url": "{{base_url}}/api", "description": "Set voice prompt audio (WAV, max 512KB). Set play=true to test immediately." } }, { "name": "keypad - Activate Keypad Mode", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"keypad\",\n \"password\": \"{{password}}\",\n \"showkeypad\": true,\n \"keep\": false,\n \"timeout\": 30,\n \"on\": true\n}" }, "url": "{{base_url}}/api", "description": "Activate/deactivate keypad mode on device screen." } } ] }, { "name": "7.6 Door Access Control", "item": [ { "name": "opendoor - Remote Door Open", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"opendoor\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"floor\": 3,\n \"msg\": \"Welcome\"\n}" }, "url": "{{base_url}}/api", "description": "Remote door open command. Optional: enrollid (for Wiegand), floor (elevator), msg (screen display 3s)." } }, { "name": "lockctrl - Door Lock State Control", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"lockctrl\",\n \"password\": \"{{password}}\",\n \"fuc\": 1\n}\n\n/* fuc: 1=Normally Open(NO), 2=Normally Closed(NC), 0=Restore normal */" }, "url": "{{base_url}}/api", "description": "Control door lock state: NO/NC mode or restore normal operation." } }, { "name": "getdoorstatus - Get Door Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getdoorstatus\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Query current door status code." } }, { "name": "setdevlock - Set Door Access Parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setdevlock\",\n \"password\": \"{{password}}\",\n \"opendelay\": 5,\n \"doorsensor\": 1,\n \"alarmdelay\": 30,\n \"InputAlarm\": 0,\n \"antpass\": 0,\n \"interlock\": 0,\n \"mutiopen\": 0,\n \"tryalarm\": 5,\n \"access_times\": 0,\n \"punchtimes\": 0,\n \"tamper\": 0,\n \"wgformat\": 26,\n \"wgoutput\": 0,\n \"cardformat\": 0,\n \"dayzone\": [],\n \"weekzone\": [],\n \"lockgroup\": [],\n \"nopentime\": [],\n \"visitortime\": []\n}" }, "url": "{{base_url}}/api", "description": "Configure door access parameters: delay, sensor, alarm, anti-passback, interlock, Wiegand format, time zones, lock groups, visitor times." } }, { "name": "getdevlock - Get Door Access Parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getdevlock\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get current door access configuration parameters." } }, { "name": "getuserlock - Get User Access Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getuserlock\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get access control settings for a specific user (timezone, group, validity period, etc.)" } }, { "name": "setuserlock - Batch Set User Access", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setuserlock\",\n \"password\": \"{{password}}\",\n \"count\": 2,\n \"record\": [\n {\n \"enrollid\": \"1001\",\n \"birthday\": \"01-15\",\n \"verifymode\": 0,\n \"weekzone\": 0,\n \"group\": 0,\n \"access_times\": 0,\n \"starttime\": \"2024-01-01 00:00:00\",\n \"endtime\": \"2025-12-31 23:59:59\"\n },\n {\n \"enrollid\": \"1002\",\n \"birthday\": \"06-20\",\n \"verifymode\": 1,\n \"weekzone\": 1,\n \"group\": 0,\n \"access_times\": 5,\n \"starttime\": \"2024-01-01 00:00:00\",\n \"endtime\": \"2025-12-31 23:59:59\"\n }\n ]\n}" }, "url": "{{base_url}}/api", "description": "Batch set user-level access parameters (verify mode, timezone, group, validity period, etc.)" } }, { "name": "deleteuserlock - Delete User Access Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"deleteuserlock\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\"\n}" }, "url": "{{base_url}}/api", "description": "Delete access control settings for a specific user." } }, { "name": "cleanuserlock - Clear All User Access Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleanuserlock\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Clear all user-level access control settings." } }, { "name": "openallfloors - Open All Floors (Elevator)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"openallfloors\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Elevator control: open access to all floors." } }, { "name": "closeallfloors - Close All Floors (Elevator)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"closeallfloors\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Elevator control: close access to all floors." } }, { "name": "openselectfloors - Open Selected Floors", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"openselectfloors\",\n \"password\": \"{{password}}\",\n \"profile\": \"1,2,5\"\n}" }, "url": "{{base_url}}/api", "description": "Elevator control: open specific floors (comma-separated floor numbers)." } }, { "name": "closeselectfloors - Close Selected Floors", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"closeselectfloors\",\n \"password\": \"{{password}}\",\n \"profile\": \"3,4\"\n}" }, "url": "{{base_url}}/api", "description": "Elevator control: close specific floors (comma-separated floor numbers)." } } ] }, { "name": "7.7 Shifts and Attendance", "item": [ { "name": "getshift - Get Shift Configuration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getshift\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get all shift definitions (up to 8 shifts, each with 3 time sections)." } }, { "name": "setshift - Set Shift Configuration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setshift\",\n \"password\": \"{{password}}\",\n \"shifts\": [\n {\n \"name\": \"Shift 1\",\n \"cutoftime\": 10,\n \"sections\": [\n { \"start\": \"09:00\", \"end\": \"12:00\", \"type\": 0 },\n { \"start\": \"13:00\", \"end\": \"18:00\", \"type\": 0 },\n { \"start\": \"\", \"end\": \"\", \"type\": 0 }\n ]\n }\n ]\n}" }, "url": "{{base_url}}/api", "description": "Configure shift schedule definitions." } }, { "name": "getbelltime - Get Bell Schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getbelltime\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get bell ringing schedule." } }, { "name": "setbelltime - Set Bell Schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setbelltime\",\n \"password\": \"{{password}}\",\n \"belltimes\": [\n { \"time\": \"09:00\", \"flag\": 1 },\n { \"time\": \"12:00\", \"flag\": 0 },\n { \"time\": \"13:00\", \"flag\": 1 },\n { \"time\": \"18:00\", \"flag\": 0 }\n ]\n}" }, "url": "{{base_url}}/api", "description": "Set bell ringing schedule." } }, { "name": "getholiday - Get Holiday Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getholiday\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get holiday definitions (up to 30 holidays with shift/dayzone override)." } }, { "name": "setholiday - Set Holiday Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setholiday\",\n \"password\": \"{{password}}\",\n \"holidays\": [\n {\n \"name\": \"New Year\",\n \"startday\": \"01-01\",\n \"endday\": \"01-03\",\n \"shift\": 0,\n \"dayzone\": 0\n }\n ]\n}" }, "url": "{{base_url}}/api", "description": "Configure holiday schedule with shift/dayzone overrides." } } ] }, { "name": "7.8 Reports", "item": [ { "name": "getreport - Get Attendance Report Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getreport\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"from\": \"2024-01-01\",\n \"to\": \"2024-12-31\"\n}" }, "url": "{{base_url}}/api", "description": "Get attendance report data filtered by user and/or date range." } }, { "name": "generatereport - Generate Report Files", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"generatereport\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"from\": \"2024-01-01\",\n \"to\": \"2024-12-31\"\n}" }, "url": "{{base_url}}/api", "description": "Trigger report generation. Download results via /download/report and /download/rawrecord after completion." } }, { "name": "checkreportprogress - Check Report Progress", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "pm.test(\u0027Progress: \u0027 + json.progress + \u0027% | Status: \u0027 + json.status + \u0027 | Finished: \u0027 + json.finished);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"checkreportprogress\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Check report generation progress percentage and status." } } ] }, { "name": "7.9 Questionnaire and Notices", "item": [ { "name": "setquestionnaire - Configure Questionnaire", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setquestionnaire\",\n \"password\": \"{{password}}\",\n \"title\": \"Health Declaration\",\n \"voice\": \"Please complete health declaration\",\n \"errmsg\": \"Declaration failed\",\n \"radio\": true,\n \"optionflag\": 3,\n \"items\": [\"Question 1\", \"Question 2\"],\n \"schedules\": [\"08:00-09:00\", \"12:00-13:00\"],\n \"usequestion\": true,\n \"useschedule\": false,\n \"card\": 0,\n \"switch_card\": 0,\n \"enrollid\": \"{{enrollid}}\",\n \"open\": true\n}" }, "url": "{{base_url}}/api", "description": "Configure on-device questionnaire (health declaration, survey, etc.)." } }, { "name": "getquestionnaire - Get Questionnaire Config", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getquestionnaire\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get current questionnaire configuration." } }, { "name": "cleanquestionnaire - Clear Questionnaire", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"cleanquestionnaire\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Clear all questionnaire settings." } }, { "name": "setcompanyname - Set Company Name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"setcompanyname\",\n \"password\": \"{{password}}\",\n \"name\": \"ACME Corporation\"\n}" }, "url": "{{base_url}}/api", "description": "Set company name displayed on device (max 21 characters)." } }, { "name": "getcompanyname - Get Company Name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getcompanyname\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get currently configured company name." } } ] }, { "name": "7.10 Video Intercom (WebRTC)", "item": [ { "name": "enablewebrtc - Initiate Video Call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"enablewebrtc\",\n \"password\": \"{{password}}\",\n \"intercom\": true,\n \"monitor\": true,\n \"inputmode\": 0,\n \"audioonly\": false,\n \"waitseconds\": 30,\n \"stunserver\": \"stun:stun.l.google.com:19302\",\n \"turnserver\": \"\",\n \"turnusername\": \"\",\n \"turnpassword\": \"\"\n}" }, "url": "{{base_url}}/api", "description": "Initiate WebRTC video call (intercom/monitor mode). Requires hardware support.\n\ninputmode: 0=direct call (no input dialog), 1=enroll/ID number, 2=phone number, 3=room number, 4=visual selection menu.\naudioonly: number / boolean — 1/true = audio only, 0/false = audio + video." } }, { "name": "getwebrtc - Get WebRTC Signaling Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getwebrtc\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Get current WebRTC signaling configuration status." } }, { "name": "checklive - Check Live Stream / ICE", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"checklive\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Check live stream status. Returns ICE candidate, callcancel notice, or null when idle. Non-standard response format." } }, { "name": "answer - SDP Answer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"answer\",\n \"password\": \"{{password}}\",\n \"sdp\": \"\u003cSDP answer string\u003e\"\n}" }, "url": "{{base_url}}/api", "description": "Send SDP answer to device for WebRTC handshake." } }, { "name": "icecandidate - ICE Candidate Exchange", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"icecandidate\",\n \"password\": \"{{password}}\",\n \"candidate\": \"\u003cICE candidate string\u003e\"\n}" }, "url": "{{base_url}}/api", "description": "Send ICE candidate to device during WebRTC negotiation." } }, { "name": "callcancel - Cancel Call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"callcancel\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Cancel active WebRTC video call." } }, { "name": "monitorcall - Monitor Mode Call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"monitorcall\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "Start monitor mode video call. Returns SDP offer if successful." } } ] }, { "name": "7.11 Biometric Verification", "item": [ { "name": "verify - Remote Biometric Verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"verify\",\n \"password\": \"{{password}}\",\n \"enrollid\": \"{{enrollid}}\",\n \"card\": \"12345678\",\n \"pwd\": 123456,\n \"name\": \"John Doe\",\n \"face\": \"\u003cBase64 face JPEG\u003e\",\n \"finger\": \"\u003cHex fingerprint template\u003e\",\n \"finger2\": \"\u003cHex second fingerprint template\u003e\",\n \"profile\": \"default\"\n}" }, "url": "{{base_url}}/api", "description": "Remote verification using face image, fingerprint templates, card, or password. Provide one or more verification factors." } }, { "name": "biomatch - Biometric Match (OSDP Test)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"biomatch\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "OSDP test: trigger biometric match. Requires config_OSDP_TEST setting." } }, { "name": "bioread - Read Raw Bio Data (OSDP Test)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"bioread\",\n \"password\": \"{{password}}\"\n}" }, "url": "{{base_url}}/api", "description": "OSDP test: read raw biometric data. Requires config_OSDP_TEST setting." } } ] }, { "name": "7.12 File Operations", "item": [ { "name": "getdir - List Directory", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getdir\",\n \"password\": \"{{password}}\",\n \"path\": \"/data\"\n}" }, "url": "{{base_url}}/api", "description": "List files and subdirectories at given path." } }, { "name": "getfile - Get File Content (Base64)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"getfile\",\n \"password\": \"{{password}}\",\n \"path\": \"/data/config.txt\"\n}" }, "url": "{{base_url}}/api", "description": "Read file content returned as Base64 encoded string." } }, { "name": "writefile - Write File", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cmd\": \"writefile\",\n \"password\": \"{{password}}\",\n \"path\": \"/data/notice.txt\",\n \"base64\": \"\u003cBase64 content\u003e\"\n}" }, "url": "{{base_url}}/api", "description": "Write content (Base64 encoded) to a file path on device." } } ] } ] }