@diegomax/ucrmjs
Wrapper library around Ubiquiti's UCRM Rest API
Last updated a month ago by diego.massanti .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @diegomax/ucrmjs 
SYNC missed versions from official npm registry.

UCRMJS - Wrapper library around Ubiquiti's UCRM Rest API

This is a NodeJS library around Ubiquiti's UCRM API.

This code is in very alpha stages, API is NOT yet frozen and might change without notice.

Example Usage

npm install @diegomax/ucrmjs

const UCRM = require('@diegomax/ucrmjs');

let config = {
    // String: Fully qualified domain name to your UCRM installation.
    "fqdn": "your.ucrmdomain.com",
    // Boolean: Connect using SSL
    "ssl": true,
    // Allows the use of self-signed SSL certificates
    "allowSelfSigned": true,
    // API Token (You can generate one from UCRM's "System > Security"),
    "token": "ucrmapitoken"
}

// Instantiate an UCRM instance. 
// By using getInstance() you are assured that the same 
// instance will always be returned (singleton behavior);
let ucrm = new UCRM(config).getInstance();

// Get an array with all services. All methods return promises.
ucrm.getServices()
.then(services => {
    console.log(services[0]);
})

Check the source code for a list of all the implemented methods.

License: MIT.

Current Tags

  • 0.2.3                                ...           latest (a month ago)

20 Versions

  • 0.2.3                                ...           a month ago
  • 0.2.2                                ...           2 months ago
  • 0.2.1                                ...           2 months ago
  • 0.2.0                                ...           2 months ago
  • 0.1.7                                ...           2 months ago
  • 0.1.6                                ...           3 months ago
  • 0.1.5                                ...           3 months ago
  • 0.1.4                                ...           3 months ago
  • 0.1.3                                ...           3 months ago
  • 0.1.2                                ...           3 months ago
  • 0.1.1                                ...           3 months ago
  • 0.1.0                                ...           3 months ago
  • 0.0.8                                ...           3 months ago
  • 0.0.7                                ...           3 months ago
  • 0.0.6                                ...           3 months ago
  • 0.0.5                                ...           3 months ago
  • 0.0.4                                ...           3 months ago
  • 0.0.3                                ...           5 months ago
  • 0.0.2                                ...           5 months ago
  • 0.0.1                                ...           5 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 33
Dependencies (2)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |