nuki-api

Synopsis

This package can be used with the NUKI Smartlock Web Api - https://api.nuki.io

npm install nuki-api

Code Example

let nuki = require('nuki-api'),
    instance = new nuki();
 
instance.apiKey = 'xxxxxxxxxxxxxxxxxxxxx'
 
instance.getSmartLocks(true).then(function (smartlocks) {
    console.log(smartlocks);
});

Motivation

This package was initially build to integrate the NUKI Smartlock with AirBnB, Booking.com, HomeAway and other internet calendars. Other relevant and compatible packages are:

1. ical-booking
2. nuki-ical (under construction)

API Reference

Get your API-key from https://web.nuki.io/nl/#/admin/web-api

Request	Parameters
setApiKey	(string) apiKey
getAccountUsers	(bool) reload (optional)
getSmartLocks	(bool) reload (optional)
getSmartLockUsers	(int) smartlockId, (bool) reload (optional)
findAccountUserById	(int) accountUserId
findAccountUserByName	(string) name
findSmartlockById	(int) smartlockId
findSmartlockByName	(string) name
findAccountUserByAuthId	(int) smartlockId, (int) authId
findAccountUserAuthByName	(int) smartlockId, (string) name
createNukiUser	(models.AccountUser) accountUser
updateNukiUser	(int) accountUserId, (models.AccountUser) accountUser
removeNukiUser	(int) accountUserId
grantAccess	(int) smartlockId, (models.SmartlockAuth) smartlockAuth
updateAccess	(int) smartlockId, (int) authId, (models.SmartlockAuth) smartlockAuth
revokeAccess	(int) smartlockId, (int) authId
getLog	(int) smartlockId (optional)

Contributors

If you want to contribute or donate to the project, please contact me on [e-mail].

License

MIT licence.