itsam v1.8.7

How to use this package

Installation

npm install itsam --save

For using in ES6 enabled front end projects:

import {itSam} from "itsam";

For Node related back end projects:

const {itSam} = require("itsam");

NOTE: please note the const name is "itSam" which is different to package name "itsam".

Use browserify to create standalone js package:

browserify main.js -o bundle.js --s itSam Must update 1 line to:

  module.exports = itSam; //Very important must be = itSam;

Initializing itSam

itSam.initialize method returns a Promise with authToken so we can easily use .then() calls

itSam
  .initialize(credentials)
  .then(res => {
    let newAuthToken = res.authToken;
    //Do Something here
  })
  .catch(err);

where,

credentials = {
  email: "your interact email",
  password: "your interact password"
};

//if successful
res = { authToken: "q34tgad45gdfgdg" };

//if unsuccessful
res = { authToken: null };

//if no credentials given when in localhost
res = {
  credentials: "provide correct login details"
};

NOTE: you only need to pass the credentials object when you are using this package in localhost.

Refetching expired token

If one of your calls to SAM fails, you should always check if the cause was an expired token. Depending on the library you use to make calls to SAM, check for errorCode===1006. Following is an example using axios.

axios
  .get("dummy-Url-For-SAM-Api")
  .then(res)
  .catch(err => {
    if (err.response.data.errorCode === 1006) {
      itSam.reGetAuthToken();
    }
  });

itSam.reGetAuthToken() also returns a Promise with an authToken in a similar format as itSam.initialize().

itSam
  .reGetAuthToken()
  .then(res => {
    let newAuthToken = res.authToken;
  })
  .catch(err);

where,

res = { authToken: "new-auth-token" };