ecodenl/ep-online-php-wrapper

PHP Wrapper for the EP Online Public REST API

v3.0.0 2023-06-09 09:14 UTC

Requires

• php: ^7.4.0|^8.0
• guzzlehttp/guzzle: ^6.3.1|^7.4.5
• psr/log: ^1.1.4|^3.0

OSL-3.0

• Bodhi Looij

README

A simple PHP wrapper for EP Online API.

Version Information

Package version	API Version	Status	PHP Version
3.x.x	3.x.x	Active support 🚀	^7.4.0 | ^8.0

Installing

composer require ecodenl/ep-online-php-wrapper

Using the API

Read the official API docs

To get a basic understanding of what is possible and what isn't, you should read the official api docs.

Setting up the connection

use Ecodenl\EpOnlinePhpWrapper\Client;
use Ecodenl\EpOnlinePhpWrapper\EpOnline;

$secret = 'asecretcodeyouneedtoobtain';

// Establish the connection
$client = Client::init($secret);

// To get extensive logging from each request
// the client accepts any logger that follows the (PSR-3 standard)[https://github.com/php-fig/log]
// This example uses the logger from laravel, but feel free to pass any logger that implements the \Psr\Log\LoggerInterface
$logger = \Illuminate\Support\Facades\Log::getLogger();
$client = Client::init($secret, $logger);

$epOnline = EpOnline::init($client);

Resources

PandEnergielabel

// Get the available energylabel from the given address (see
// the official api docs (https://public.ep-online.nl/swagger/index.html) for all possible parameters  
$label = $epOnline->pandEnergielabel()
  ->byAddress([
    'postcode' => '3255MC',
    'huisnummer' => 13,
  ]);

// Search on a ID from the bag ("adresseerbaarObjectId") 
$address = $epOnline->pandEnergielabel()
    ->byId('1924010000030064');