@mobie/mobie

1.3.0 • Public • Published

Mobie Javascript SDK

About

This is the Javascript SDK for the Mobie API.

Installation

via NPM:

npm install @mobie/mobie

via CDN:

https://cdn.jsdelivr.net/npm/@mobie/mobie@{version_number}/build/mobie.min.js

or use the minified file in the build folder

Getting started

Client Side

Initialize the SDK with:

window.mobie = new Mobie(config);

or

const mobie = new Mobie(config);(NodeJS)

Your config object should contain:

  • storageMethod - Options are session for sessionStorage and local for localStorage

  • apiVersion - Default is 3 (Version 3 is the only currently supported version)

  • apiToken - Your Mobie API token

Example:

	var config = {
		apiVersion: 3, 
		storageMethod: "local",
		apiToken: "authenticationTokenHere"
	}

Server Side (NodeJS)

Initialize the sdk with: const mobie = new Mobie(config);

Your config object should contain:

  • apiVersion - Default is 3 (Version 3 is the only currently supported version)

  • apiToken - Your Mobie API token

Example:

	var config = {
		apiVersion: 3, 
		apiToken: "authenticationTokenHere"
	}

Custom API url

To use this SDK with a custom API url, your config object should contain customAPIURL

Example:

	var config = {
		...,
		customAPIURL: "https://whatever.stuff/
	}

Documentation and usage

For more detailed documentation and usage Docs.

License

MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i @mobie/mobie

Weekly Downloads

1

Version

1.3.0

License

MIT

Unpacked Size

486 kB

Total Files

12

Last publish

Collaborators

  • odinsplasmarifle
  • dblaze47
  • michailb