primeinc/edgeapi

A PHP wrapper for the EdgeOS API

dev-master / 0.1.x-dev 2015-06-18 00:51 UTC

Requires

• php: >=5.5.0
• guzzlehttp/guzzle: 6.0.1

Requires (Dev)

• filp/whoops: ^1.1

MIT

• William James

README

A PHP wrapper for the EdgeOS API

Installation

1. Use Composer to install EdgeAPI into your project:

   composer require primeinc/edgeapi

2. Setup the endpoint and guzzle client

   //create new endpoint config, with required info
   $endpoint = new \PrimeInc\EdgeApi\Endpoint(array(
       'protocol' => 'https',
       'domain' => '192.168.1.1',
       'port' => '443',
       'username' => 'ubnt',
       'password' => 'ubnt',
       // don't have a valid cert? set the following to false
       'verify' => true
   ));
   $client = new \PrimeInc\EdgeApi\Client($endpoint);
   $client->data('sys_info');
   
   echo $client->prettyJson(); // this will grab the last data fetched automatically

   For more options, have a look at the example files in examples/ to get a feel for how things work. There is also a standalone template if you don't wish to use this libray.

Todo's

• Catch & Handle Errors
• Write Tests
• Ability to change endpoint configuration via POST requests