Mpost JavaScript SDK

This SDK aims to help the development of integrations with Mpost that use JavaScript, providing an easy interface to communicate with Mpost's REST API.

Requirements

To use this SDK, you will need:

Node.js v6.3.0 or above

Node installation will include NPM, which is responsible for dependency management.

Installation

Node.js

npm install @mpost/mpost-js-sdk

import Mpost from '@mpost/mpost-js-sdk';

Usage

This SDK relies heavily on Promises, making it easier to handle the asynchronous requests made to the API. The SDK provides a Mpost object containing several methods which map to the calls and parameters described in Mpost's API documentation.

The following snippet is a generic example of how to use the SDK. If you need details for a specific module, refer to the samples folder.

Before executing any request, you need to authorize the calls to the API:

Using a permanent token

const mpost = new Mpost({
  baseURL: "https//portal.mpost.com/api/",
  permanentToken: "<token>",
});

Using OAuth2

Call the constructor with your configuration

const mpost = new Mpost({
  baseURL: "https://portal.mpost.com/api/",
  clientId: "<your OAuth2 client id>",
  clientSecret: "<your OAuth2 client secret>",
  redirectUri: "<url where user will be redirected after authenticating>"
});

Create an authorization URL, login and get one-time authorization code

const authorizationURL = mpost.makeAuthorizationURL();

Exchange code for an access token

mpost.getToken(code);

If you already have an access token, you can also initialize Bynder with the token directly:

const mpost = new Mpost({
  baseURL: "http://api-url.mpost.io/api/",
  clientId: "<your OAuth2 client id>",
  clientSecret: "<your OAuth2 client secret>",
  redirectUri: "<url where user will be redirected after authenticating>",
  token: "<OAuth2 access token>"
});

Making requests

You can now use the various methods from the SDK to create delivery requests, fetch delivery requests and other data. Following the Promises notation, you should use .then()/.catch() to handle the successful and failed requests, respectively.

Most of the calls take an object as the only parameter but please refer to the API documentation to tune the query as intended.

Get Delivery Requests

mpost
  .getDeliveryRequests({
    limit: 20,
    page: 1
  })
  .then(data => {
    // TODO Handle data
  })
  .catch(error => {
    // TODO Handle the error
  });

Craete Delivery Request

mpost
  .createDeliveryRequest({
    pickup_address: {
        latitude: 37.785834,
        longitude: -122.406417,
        address: "Globe Round About",
        detailed_address: "Sunrays House, Near Globe Cinema Roundabout, Nairobi City"
    },
    delivery_address: {
        latitude: 40.659569,
        longitude: -73.933783,
        address: "Globe Round About",
        detailed_address: "Sunrays House, Near Globe Cinema Roundabout, Nairobi City"
    },
    recipient_name: "Elias Baya",
    recipient_mobile: "0712345678",
    item_type: "Test",
    pickup_time: "2022-02-02 11:11:00"
  })
  .then(data => {
    // TODO Handle data
  })
  .catch(error => {
    // TODO Handle the error
  });

Calculate Distance and Delivery Cost

mpost
  .calculateDistance({
    pickup_address: {
        latitude: -0.9534506,
        longitude: 37.0820681
    },
    delivery_address: {
        latitude: -1.046594,
        longitude: 37.060197
    }
  })
  .then(data => {
    // TODO Handle data
  })
  .catch(error => {
    // TODO Handle the error
  });

Available methods

Authentication

makeAuthorizationURL()
getToken()

Delivery

getDeliveryRequests(queryObject)
createDeliveryRequest(queryObject)
calculateDistance(queryObject)

Contribute to the SDK

If you wish to contribute to this repository and further extend the API coverage in the SDK, here are the steps necessary to prepare your environment:

Clone the repository
In the root folder, run npm install to install all of the dependencies.
Create a secret.json file with the following structure:

{
  "baseURL": "http://api-url.bynder.io/api/",
  "clientId": "<your OAuth2 client id>",
  "clientSecret": "<your OAuth2 client secret>",
  "redirectUri": "<url where user will be redirected after authenticating>"
}

The following gulp tasks are available:

gulp lint - Run ESlint and check the code.
gulp build - Run webpack to bundle the code in order to run in a browser.
gulp babel - Run Babel to create a folder 'dist' with ES2015 compatible code.
gulp doc - Run JSDoc to create a 'doc' folder with automatically generated documentation for the source code.
gulp webserver - Deploy a web server from the root folder at localhost:8080 to run the html samples (in order to avoid CORS problems).

ekbaya / mpost-js-sdk