@2klic/2klic_io-sdk
Javascript SDK for 2klic API
Last updated 4 years ago by joellavoie .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @2klic/2klic_io-sdk 
SYNC missed versions from official npm registry.

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
    };

});

Current Tags

  • 2.34.8                                ...           latest (4 years ago)

69 Versions

  • 2.34.8                                ...           4 years ago
  • 2.34.7                                ...           4 years ago
  • 2.34.1 [deprecated]           ...           4 years ago
  • 2.34.0 [deprecated]           ...           4 years ago
  • 2.33.1 [deprecated]           ...           4 years ago
  • 2.32.1 [deprecated]           ...           4 years ago
  • 2.31.1 [deprecated]           ...           4 years ago
  • 2.31.0 [deprecated]           ...           4 years ago
  • 2.30.0 [deprecated]           ...           4 years ago
  • 2.29.0 [deprecated]           ...           4 years ago
  • 2.28.0 [deprecated]           ...           4 years ago
  • 2.27.0 [deprecated]           ...           4 years ago
  • 2.26.1 [deprecated]           ...           4 years ago
  • 2.26.0 [deprecated]           ...           4 years ago
  • 2.24.0 [deprecated]           ...           4 years ago
  • 2.23.0 [deprecated]           ...           4 years ago
  • 2.22.0 [deprecated]           ...           4 years ago
  • 2.21.0 [deprecated]           ...           4 years ago
  • 2.20.1 [deprecated]           ...           4 years ago
  • 2.20.0 [deprecated]           ...           4 years ago
  • 2.19.0 [deprecated]           ...           4 years ago
  • 2.18.7 [deprecated]           ...           4 years ago
  • 2.18.5 [deprecated]           ...           4 years ago
  • 2.18.2 [deprecated]           ...           4 years ago
  • 2.18.1 [deprecated]           ...           4 years ago
  • 2.18.0 [deprecated]           ...           4 years ago
  • 2.17.2 [deprecated]           ...           4 years ago
  • 2.17.1 [deprecated]           ...           4 years ago
  • 2.17.0 [deprecated]           ...           4 years ago
  • 2.16.37 [deprecated]           ...           4 years ago
  • 2.16.34 [deprecated]           ...           4 years ago
  • 2.16.33 [deprecated]           ...           4 years ago
  • 2.16.32 [deprecated]           ...           4 years ago
  • 2.16.31 [deprecated]           ...           4 years ago
  • 2.16.30 [deprecated]           ...           4 years ago
  • 2.16.27 [deprecated]           ...           4 years ago
  • 2.16.26 [deprecated]           ...           4 years ago
  • 2.16.25 [deprecated]           ...           4 years ago
  • 2.16.24 [deprecated]           ...           4 years ago
  • 2.16.23 [deprecated]           ...           4 years ago
  • 2.16.22 [deprecated]           ...           4 years ago
  • 2.16.21 [deprecated]           ...           4 years ago
  • 2.16.19 [deprecated]           ...           4 years ago
  • 2.16.18 [deprecated]           ...           4 years ago
  • 2.16.17 [deprecated]           ...           4 years ago
  • 2.16.16 [deprecated]           ...           4 years ago
  • 2.16.15 [deprecated]           ...           4 years ago
  • 2.16.14 [deprecated]           ...           4 years ago
  • 2.16.13 [deprecated]           ...           4 years ago
  • 2.16.12 [deprecated]           ...           4 years ago
  • 2.16.11 [deprecated]           ...           4 years ago
  • 2.16.10 [deprecated]           ...           4 years ago
  • 2.16.9 [deprecated]           ...           4 years ago
  • 2.16.8 [deprecated]           ...           4 years ago
  • 2.14.0 [deprecated]           ...           4 years ago
  • 2.13.0 [deprecated]           ...           4 years ago
  • 0.0.57 [deprecated]           ...           4 years ago
  • 2.8.0 [deprecated]           ...           4 years ago
  • 2.9.0 [deprecated]           ...           4 years ago
  • 2.7.0 [deprecated]           ...           4 years ago
  • 2.6.0 [deprecated]           ...           4 years ago
  • 2.5.0 [deprecated]           ...           4 years ago
  • 2.4.0 [deprecated]           ...           4 years ago
  • 2.3.0 [deprecated]           ...           4 years ago
  • 2.2.0 [deprecated]           ...           4 years ago
  • 2.1.0 [deprecated]           ...           4 years ago
  • 2.0.0 [deprecated]           ...           4 years ago
  • 0.0.56 [deprecated]           ...           4 years ago
  • 0.0.55 [deprecated]           ...           4 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 69
Last Month 207
Dependencies (7)
Dev Dependencies (15)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |