kinow-javascript-sdk v2.0.28

kinow-javascript-sdk

KinowJavascriptSdk - JavaScript client for kinow-javascript-sdk Reference for Server API (REST/Json) This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.28
• Package version: 2.0.28
• Build date: 2023-05-12T10:25:45.501Z
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

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 kinow-javascript-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 kinow-javascript-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('kinow-javascript-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/kinow-io/kinow-javascript-sdk then install it via:

    npm install kinow-io/kinow-javascript-sdk --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

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

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix['X-Client-Id'] = "Token"

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix['X-Client-Secret'] = "Token"

var api = new KinowJavascriptSdk.ActorsApi()

var categoryId = 789; // {Integer} Category ID to fetch

var actorId = 789; // {Integer} Actor ID to attach

api.attachActorToCategory(categoryId, actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Enable Debug Logs

You can enable debug logging by following the pattern shown above (success and error callback).

When submitting a support request, it is best to provide the logs file for a faster resolution of your issue (see below).

// append to file snippet (Node.js)
const fs = require('fs');

// Append your log string to the output file
fs.appendFileSync('output', '\n' + log);

Documentation for API Endpoints

All URIs are relative to https://api.kinow.com/api