drinkynet/codelocks-api

Basic wrapper for the Codelocks Netcode API

Codelocks API Wrapper

Lightweight PHP wrapper for the Codelocks Connect API., _(*1)

This wrapper update is aimed at being backwards compatible with the previous version making it a drop-in replacement to connect to the new API with no breaking changes to method calls or structure., _(*2)

Installing

Install via composer:, _(*3)

composer require drinkynet/codelocks-api

Examples

Create an instance of the Codelocks class with your API key and default Access Key, _(*4)

$codelocks = new \drinkynet\Codelocks\Codelocks($key, $accessKey);

$netcode = $codelocks->netcode();

Get a netcode for lock 0000000000000000000000000000001a that is valid now:, _(*5)

$netcode->lock('0000000000000000000000000000001a')->get();

Get a netcode for lock 0000000000000000000000000000001a that is valid for a specific time and date:, _(*6)

$code = $netcode->lock('0000000000000000000000000000001a')
    ->date(new \DateTime('2016-09-23'))
    ->hour(9)
    ->duration(1)
    ->get();

Note: You can get the lock ID for each lock from the lock list returned by the ->lock() method call, _(*7)

Get an initialisation sequence for a lock model:, _(*8)

$codelocks = new \drinkynet\Codelocks\Codelocks($key, $accessKey);

// Init sequence data with default master code
$init = $codelocks->init()
    ->lockModel('K3CONNECT')
    ->get();

// Init sequence data with custom master code
$init = $codelocks->init()
    ->lockModel('K3CONNECT')
    ->masterCode('12345678')
    ->get();

Get a list of locks associated with the API credentials:, _(*9)

$codelocks = new \drinkynet\Codelocks\Codelocks($key, $accessKey);

// Uses the accessKey set earlier
$locks = $codelocks->lock()->get();

// Use a different accessKey associated with the API key
$locks $codelocks->lock('abcde12345')->get();

Previous versions

If you are using the "Codelocks Customer API" install the 6.0.1 version of this wrapper via composer., _(*10)

Note: API versions prior to this are nolonger available online., _(*11)