Download the PHP package rithy/zkteco-adms without Composer
On this page you can find all versions of the php package rithy/zkteco-adms. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rithy/zkteco-adms
More information about rithy/zkteco-adms
Files in rithy/zkteco-adms
Package zkteco-adms
Short Description Laravel package for ZKTeco ADMS Push SDK integration using the same logic as the original Laravel implementation.
License MIT
Informations about the package zkteco-adms
Laravel ZKTeco ADMS
A production-ready Laravel package for integrating ZKTeco biometric devices using the ADMS (Push SDK) protocol.
This package is extracted from a real-world production attendance system and preserves the original Laravel implementation while making it reusable across multiple Laravel applications.
Features
- 🚀 ADMS (Push SDK) Integration
- 📡 Real-time Attendance Synchronization
- 👥 User Synchronization
- 🖐 Fingerprint Template Synchronization
- 😀 Face Template Synchronization
- 💾 Biometric Data Management
- 🖥 Device Registration & Heartbeat
- 📥 Device Command Queue
- 🔄 Command Response Tracking
- ⏱ Automatic Attendance Synchronization
- 🏭 Multi-device Support
- ⚡ Laravel 11 & Laravel 12 Compatible
Requirements
RequirementVersion
- PHP8.2+
- Laravel11.x +
Installation
1. Install Package
If composer require rithy/zkteco-adms is not working
Add the repository manually in your project's composer.json:
Then run:
2. Publish Configuration
3. Publish Database Migrations
4. Publish Views
5. Run Migrations
6. Configure Scheduler (Optional)
The package provides real-time attendance ingestion from device callbacks.
The scheduler is optional, but recommended to ensure attendance sync stays consistent. Use it as a safety net for cases like temporary network issues, delayed device pushes, or missed callbacks.
The package provides the following Artisan command:
Register it in your application's routes/console.php:
Finally, ensure Laravel's scheduler is running by adding the standard cron entry on your server:
7. Configure CSRF Exclusion
Since ZKTeco devices cannot generate Laravel CSRF tokens, exclude the ADMS endpoint in bootstrap/app.php:
Configuration
After publishing, edit:
Example:
Routes
The package automatically registers these endpoints:
MethodEndpointDescriptionGET/iclock/cdataDevice HandshakePOST/iclock/cdataAttendance UploadGET/iclock/getrequestDevice PollingPOST/iclock/devicecmdCommand ResponseVerify:
Database Tables
The package creates the following tables:
zk_deviceszk_userszk_biodataszk_attendanceszk_commands
Supported Data
Attendance
- PIN
- Timestamp
- Verify Type
- Status
Users
- User ID
- Name
- Privilege
- Password
- Card Number
Biometrics
- Fingerprint Templates
- Face Templates
Device Commands
- Attendance Sync
- User Sync
- Biometric Sync
- Restart Device
- Refresh Data
- Delete User
- Add User
Package Structure
Typical Data Flow
Multi-device Support
Supports unlimited ZKTeco devices.
Example:
Each device is uniquely identified by its Serial Number (SN).
Production Deployment Checklist
- Enable HTTPS.
- Set
APP_ENV=production. - Set
APP_DEBUG=false. - Configure the scheduler cron.
- Configure queue workers if applicable.
- Exclude
iclock/*from CSRF validation. - Cache configuration and routes. Optimize the application:
Contributing
Contributions are welcome.
- Fork the repository.
- Create a feature branch.
- Commit your changes.
- Open a Pull Request.
License
MIT License
Author
Rithy Sam
Laravel Developer
Email: [email protected]
Cambodia 🇰🇭
# Acknowledgements
Inspired by the work on the adms-server-ZKTeco project:
https://github.com/saifulcoder/adms-server-ZKTeco/tree/main
Special thanks to the Laravel community and to ZKTeco for the ADMS Push SDK protocol.
All versions of zkteco-adms with dependencies
illuminate/support Version ^11.0|^12.0
illuminate/routing Version ^11.0|^12.0
illuminate/database Version ^11.0|^12.0