-
- GitHub
- GitLab
- Bitbucket
-
By logging in you accept
our terms of service
and privacy policy
Javascript SDK for 2klic API
Homepage Repository npm Download
bower install 2klic-sdk --save
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.
var Klic = require('@2klic/2klic-sdk');
var KlicSDK = new Klic();
KlicSDK.devices.list().then(function(devices){
console.log(devices);
return devices
});
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.
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
};
});
The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.
Learn more →Login to resync this project