@knetik/knetikcloud-sdk v3.1.4

knetikcloud-sdk

KnetikCloud - JavaScript client for knetikcloud-sdk This is the spec for the Knetik API. Use this in conjunction with the documentation found at https://knetikcloud.com. This SDK is automatically generated by the Swagger Codegen project:

• API version: latest
• Package version: 3.1.4
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.knetik.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install knetikcloud-sdk --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your knetikcloud-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('knetikcloud-sdk') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

KnetikCloud (JSAPI) uses a strict Oauth 2.0 implementation with the following grant types:

• Password grant: Used for user authentication, usually from an unsecured web or mobile client when a fully authenticated user account is required to perform actions. ex:

POST /oauth/token?grant_type=password&client_id=web&username=jdoe&password=68a4sd3sd

• Client credentials grant: Used for server authentication or secured clients when the secret key cannot be discovered. This kind of grant is typically used for administrative tasks on the application itself or to access other user's account information.

POST /oauth/token grant_type=client_credentials&client_id=server-client-id&client_secret=1s31dfas65d4f3sa651c3s54f 

The endpoint will return a response containing the authentication token as follows:

{"access_token":"25a0659c-6f4a-40bd-950e-0ba4af7acf0f","token_type":"bearer","expires_in":2145660769,"scope":"write read"}

Use the provided access_token in sub-sequent requests to authenticate (see code below). Make sure you refresh your token before it expires to avoid having to re-authenticate.

Please follow the installation instruction and execute the following JS code:

var KnetikCloud = require('knetikcloud-sdk');

var api = new KnetikCloud.AccessTokenApi()

var grantType = "client_credentials"; // {String} Grant type

var clientId = "knetik"; // {String} The id of the client

var opts = { 
  'clientSecret': "clientSecret_example", // {String} The secret key of the client.  Used only with a grant_type of client_credentials
  'username': "username_example", // {String} The username of the client. Used only with a grant_type of password
  'password': "password_example", // {String} The password of the client. Used only with a grant_type of password
  'token': "token_example", // {String} The 3rd party authentication token. Used only with a grant_type of facebook, google, etc (social plugins)
  'refreshToken': "refreshToken_example" // {String} The refresh token obtained during prior authentication. Used only with a grant_type of refresh_token
};
api.getOAuthToken(grantType, clientId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://devsandbox.knetikcloud.com