2is

@2klic/2klic_io-sdk

Javascript SDK for 2klic API

Showing:

Popularity

Downloads/wk

427

Maintenance

No Maintenance Data Available

Package

Dependencies

7

Size (min+gzip)

69.1KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

2Klic.io SDK

Installing the library from the private repository

bower install 2klic_io-sdk --save

Getting Started

Include the library in your index.html

<script src="bower_components/dist/sdk.js"></script>

Instantiate a new engine:

var platform = new Klic();

By default, the engine will point to https://api.2klic.io. If you want to work with a local development engine, just use the url option:

var platform = new Klic({url: 'http://localhost:5000'});

2Klic.io is using JWT tokens for authentication. In order to use most of the available methods and helpers, you need to retrieve a valid token.

How to instantiate in Node:

var Klic = require('@2klic/2klic_io-sdk');
var KlicSDK = new Klic();
KlicSDK.devices.list().then(function(devices){
    console.log(devices);
    return devices
});

Configuring our SDK to retrieve a token

You need to set the following options in order to retrieve a valid token:

url: Url of the 2klic.io instance you want to use. default to https://api.2klic.io
auth: {
    token: An existing token (previously retrieved) or nothing
},
unsafe: true indicates that we're in an unsafe environment (client app, browser, etc)
app_key : The key of the app as provided by 2klic.io
app_secret: Optional. The secret if you are in a safe environment (do not use for client or browser app)

With these options you can instantiate the Klic instance:

var platform = new Klic({
    unsafe: isClient,
    app_key: "b2423a98430c03213d7ad86033622f5066a44b69"
});

Note that we haven't provided any token as we don't have one yet.

Retrieving a valid token

You execute the authenticate method to retrieve your token :

platform.authenticate({username:username, password:password}).then(function(result) {

    // Save the token for subsequent calls
    platform.auth = {
        token: result.token
    };

});

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100