@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 i -s @orbis-systems/orbis-api-client

Inclusion

Node

require("babel-core/register");
require("babel-polyfill");

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

or

require("babel-core/register");
require("babel-polyfill");

import APIClient from '@orbis-systems/orbis-api-client';

Browser

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

Usage

Node

const config = {
   base_url: 'https://example.com/', // Obtained from Orbis
   sign_url: 'https://example.com/'  // Endpoint for getting the signature
};

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

Browser

const config = {
   base_url: 'https://example.com/', // Obtained from Orbis
   sign_url: 'https://example.com/'  // Endpoint for getting the signature
};

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)