Download the PHP package darvis/nuki without Composer
On this page you can find all versions of the php package darvis/nuki. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package nuki
darvis/nuki
A Laravel package for the NUKI Web API. Provides a clean, typed interface for managing smartlocks, fetching activity logs, managing authorizations (keypad codes / app users), and receiving webhook callbacks.
- PHP 8.2+ — Laravel 11, 12, 13
- Bearer (API token) and OAuth 2.0 Authorization Code support
- Account-aware: a single application can manage multiple NUKI accounts
- Webhook receiver with HMAC signature verification and idempotent dispatch
- Built-in Livewire 3.5+ / 4 + Flux 2 UI: dashboard, activity timeline, smartlocks, keypad authorizations, webhooks and OAuth status
- Optional self-contained user-auth (
darvis-nukiguard) with email OTP, sub-users, per-smartlock permissions and a weekday bitmask
Documentation
Full developer documentation lives in docs/. Quick links:
- Getting started — install, publish, "hello world".
- Configuration reference — every
NUKI_*env var andconfig/nuki.phpkey. - NUKI API authentication — token mode,
OAuth, multi-account scoping with
Nuki::as(). - API reference — every public method on every resource, plus DTOs and console commands.
- Users and permissions — package-managed users, sub-user permissions, weekday bitmask, OTP, password reset.
- Auth routes — every URL registered when the auth feature is on.
- Webhooks — signature verification, dedup,
NukiWebhookReceivedevent. - UI and localization — Livewire components, locales, layout override.
- Demo mode —
NUKI_DEMO=true, seeded accounts. - Troubleshooting — common errors and fixes.
Installation
Service provider and Nuki facade are auto-discovered.
Minimal .env (token mode, single account)
Generate the token in the NUKI Web portal under API. For multi-account or OAuth, see NUKI API authentication.
Hello world
For everything else — every method on every resource, the DTO shapes, multi-account, OAuth, webhooks, the bundled UI, the optional user-auth — see docs/.
Webhooks
Listen for inbound events:
See docs/webhooks.md for signature verification, deduplication and registering the callback with NUKI.
Demo mode
Intercepts every call to api.nuki.io and answers with realistic canned data.
Combine with php artisan db:seed --class="Darvis\\Nuki\\Database\\Seeders\\NukiDemoSeeder"
to populate the multi-account switcher. Perfect for screenshots and
walk-throughs; never enable in production. See
docs/demo-mode.md.
User authentication (optional)
Registers a darvis-nuki auth guard, gates /nuki/* behind it, and ships
login / OTP / register / password-reset Livewire screens. Main users can
create sub-users with per-smartlock permissions, a validity window and a
weekday bitmask. See docs/users-and-permissions.md.
Testing
Credits
- Author: Arvid de Jong (Darvis) — https://darvis.nl
License
MIT — see LICENSE.
All versions of nuki with dependencies
ext-json Version *
laravel/framework Version ^11.0|^12.0|^13.0
livewire/flux Version ^2.0
livewire/livewire Version ^3.5|^4.0