kroba_licence_sdk_js v0.2.6

kroba_licence_sdk

KrobaLicenceSdk - JavaScript client for kroba_licence_sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: ce2dcc04-fe57-46e6-9f3e-b8a0b61022ae
• Package version: ce2dcc04-fe57-46e6-9f3e-b8a0b61022ae
• Build package: org.openapitools.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 kroba_licence_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 kroba_licence_sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('kroba_licence_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

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

var KrobaLicenceSdk = require('kroba_licence_sdk_js');

var defaultClient = KrobaLicenceSdk.ApiClient.instance;

// Configure API key authorization: sso_auth
var sso_auth = defaultClient.authentications['sso_auth'];
sso_auth.apiKey = "Bearer <YOUR API KEY>"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//sso_auth.apiKeyPrefix['Authorization'] = "Token"

var api = new KrobaLicenceSdk.DefaultApi()
var licenceId = "licenceId_example"; // {String} 
var opts = {
  'token': "token_example" // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateLicence(licenceId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://licence-backend.glitch.me

Documentation for Models

• KrobaLicenceSdk.Model201

Documentation for Authorization

sso_auth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header