Build on ZKTeco with one JSON API.
38 operations, standard JSON over HTTPS, no SDK required. Receive punches by webhook, command the machine by REST.
The Cams Gateway is a JSON-over-HTTPS API for ZKTeco and other biometric devices, with 38 operations: 11 real-time callbacks (device to your server) and 27 REST commands (your server to device). Callbacks carry an AuthToken, can be AES-256 encrypted, and must be answered with HTTP 200. No SDK or middleware is required.
Last updated 29 October 2026 · Independent of ZKTeco · Terms
What is in the API
11 callbacks (device to you)
RealTimePunchLog, RealTimeAttendancePhoto, UserUpdated variants (card, password, fingerprint, face, palm, photo), manual user delete and modify.
27 REST commands (you to device)
LoadLog, LoadDeviceInformation, AddUser in many template combinations, DeleteUser, DeleteAllUser, EnableUser, DisableUser, ResendAttendance, ResendAllUser, EnrollFingerPrint, UpdateAccessTime and more. Typical latency about 15 seconds.
Callback you receive
{
"OperationID": "RealTimePunchLog",
"SerialNumber": "ZKV5L-44021",
"PunchLog": { "UserId": "EMP-1042", "LogTime": "2026-10-29T09:02:14+05:30", "InputType": "face" },
"AuthToken": "<validate>"
}
// reply immediately: HTTP 200 {"status":"done"}Developer tooling
API Monitor
Portal for callback URLs, AuthTokens, Security Keys, device status, REST endpoint and Service Tag IDs.
Postman collection
Covers all 27 REST operations with base_url, stgid and auth_token variables.
AI code prompts
Ready prompts for ChatGPT, Claude and Gemini to generate your receiver in 7 languages.
PHP example
A worked PHP and MySQL receiver. Any language that can serve HTTPS works.
Reliability
Offline caching and command queuing; HTTPS on port 443 (80 allowed, 8123 for testing).
MCP for agents
The same devices are available to AI agents at https://agent.camsbiometrics.com.
Documentation
Full reference: Cams Biometric Gateway: Web API 3.0. There are separate pages for callback operations, REST operations, the reference, compatibility, testing, the PHP example and AI code prompts. Cams does not provide Python or JavaScript SDKs; the API is plain JSON over HTTPS, so any HTTP library works.
Frequently asked questions
Is there an SDK?▾
No SDK is needed. It is JSON over HTTPS. A PHP example, a Postman collection and AI code prompts are provided.
How do I verify callbacks?▾
Every callback includes an AuthToken that your server should validate. You can also enable AES-256 payload encryption with a Security Key.
Can I test without a server?▾
Yes. Use a tunnel such as ngrok, or a workflow tool's webhook URL, to receive test callbacks.
Which ZKTeco devices work?▾
Push-capable models verified at developer.camsbiometrics.com, plus others via Hybrid Push. See the compatibility page.
Related
Make your first API call this afternoon.
Account in about 30 seconds, machine online in a few minutes. Free sandbox key.