README

A PHP Wrapper for the XMS API from Xirrus / Cambium Networks.

Installation

You can install the package via composer:

composer require fredbradley/xirrusapi

Usage

// Override default options
$default_options = [
   'verify' => true, // set to false, if you are up against SSL verification issues 
   /**
    * Please note: Setting this to false is not recommended 
    * and weakens the security of your system, but
    * sometimes for testing purposes is nessecary
    */
];
$api = new \FredBradley\XirrusApi\XirrusApi("https://xmsserver.tld:9443", "exampleusername", "examplepassword", $default_options);
$api->request("GET", "stations.json"); // This will get you a php json object of your api result dataset

Further helper methods will be coded into this package in time.

API Documentation

Documentation can be found locally on your own XMS Hosted appliance, under "Settings -> XMS API -> API Documentation"

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email code@fredbradley.co.uk instead of using the issue tracker.

fredbradley / xirrusapi

Maintainers

Details