drinkynet/codelocks-api

Basic wrapper for the Codelocks Netcode API

7.0.3 2021-11-30 16:13 UTC

Requires

• php: >=5.4

Requires (Dev)

• phpunit/phpunit: 7.0.*
• squizlabs/php_codesniffer: 2.*
• vlucas/phpdotenv: ^2.0

MIT

• James Drinkwater

README

Lightweight PHP wrapper for the Codelocks Connect API.

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.

Installing

Install via composer:

composer require drinkynet/codelocks-api

Examples

Create an instance of the Codelocks class with your API key and default Access Key

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

$netcode = $codelocks->netcode();

Get a netcode for lock 0000000000000000000000000000001a that is valid now:

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

Get a netcode for lock 0000000000000000000000000000001a that is valid for a specific time and date:

$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

Get an initialisation sequence for a lock model:

$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:

$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.

Note: API versions prior to this are nolonger available online.