Web Getting Started

Kelvin SDK Client provides a simple way to integrate our Authentication, Services and Models inside your project.

Requirements

To run our SDK inside your project you need to support the following versions:

• Rxjs: 6.5.X
• Axios
• Optionally, keycloak-js to handle the authentication

Installation

Install the Kelvin SDK Client, RxJS and Axios Client:

npm install @kelvininc/web-client-sdk axios rxjs@~6.5.4  --save

Setup without Keycloak

Next, you need to setup the main.js file:

import KelvinSDK from "@kelvininc/web-client-sdk";
import axios from "axios";

const configuration = {
    baseUrl: '<your-base-url>',
    authConfig: {
        clientId: '<your-kelvin-client>',
        realm: '<your-kelvin-realm>',
        url: '<your-authentication-url>'
    }
}

KelvinSDK.initialize(configuration, axios);

The Kelvin SDK Client is now ready to use. If you need to initialize our SDK services, this example can run inside your Application:

Usage

You can import service and modules from Kelvin Core.

import { AuthService, ACPService } from "@kelvininc/web-client-sdk";

Authentication process

AuthService.login({
    username: '<username or email>',
    password: '<password>'
}).subscribe(({ accessToken, refreshToken }) => doSomething());

Get a list of Assets

AssetService.listAsset({
    pageSize: 20
}).subscribe(assetList => doSomething(assetList));

Promise transformation (if you prefer)

AssetService.listAsset({ pageSize: 20 }).toPromise()
  .then(assetList => doSomething(assetList));