README

LOC8 API

This is an api wrapper that connects to the LOC8 inventory management platform. It currently handles the following requests:

1. Authentication

You use the authentication module to handle login and registration requests

Login request

Attempt to login a user using an id number and a password. If the login request is successful it will return a session variable that can be used to manage the user's session.

Locate = require('locate-api')({ apiKey: 'AAABBBZZZ', mode: 'production' });
authenticate = Locate.AUTHENTICATE;

let options = {
  id_number: "",
  password: ""
};  
authenticate.loginUser(options)
  .then(function(response) {
    // Handle login
  })
  .catch(function(error) {
    throw error;
  });

Registration requests

Attempt to register a user. If the registration request is successful it will return a session variable that can be used to manage the user's session.

Locate = require('locate-api')({ apiKey: 'AAABBBZZZ', mode: 'production' });
authenticate = Locate.AUTHENTICATE;

let options = {
  first_name: "",
  last_name: "",
  other_names: "",
  id_number: "",
  id_type: "",
  msisdn: "",
  email: "",
  password: "",
  dob: "",
  gender: "",
};  
authenticate.registerUser(options)
  .then(function(response) {
    // Handle registration
  })
  .catch(function(error) {
    throw error;
  });