@orbis-systems/orbis-api-client

This is in early development and is not ready for implementation.

This library comes comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law.

Installation

npm install orbis-api-client --save

Inclusion

Node

const APIClient = require("orbis-api-client");

or

import APIClient from 'orbis-api-client';

Browser

<script src="browser-bundle.js"></script>

Usage

Node

const config = {
   cert: fs.readFileSync('./cert.pem'), //Obtained from Orbis
   token: '123456', //Obtained from Orbis. Must be string (not int)
   domain: 'https://example.com/', //Obtained from Orbis
   base_url: 'https://example.com/', //Obtained from Orbis
};

(async () => 
{
    let client = new APIClient(config);
    await client.login('username', 'password');
});

Browser

const config = {
   cert: fs.readFileSync('./cert.pem'), //Obtained from Orbis
   token: '123456', //Obtained from Orbis. Must be string (not int)
   domain: 'https://example.com/', //Obtained from Orbis
   base_url: 'https://example.com/', //Obtained from Orbis
};

var client = new APIClient(config)
client.login('username', 'password');

Session Stores

By default, the session store will use LocalStorage. In the browser, LocalStorage will utilize localStorage, and in NodeJS it will store them in ./session.

You can create a custom session store by extending the SessionStore class. To use it, pass it as the session_store on the config like:

const config = {
   ...
   session_store: CustomStore,
   ...
};

You must implement the methods:

• get(key)
• set(key, value, expiration_in_minutes)
• has(key) (Returns boolean. Should also return false if it has expired)