Fork me on GitHub

Esandex

A lightweight API sandbox for the Esendex REST API.

View the API Documentation

Note: The documentation is still in progress.

Version 1.0

RAML Esendex REST API v1.0 RAML
Documentation Auto-generated Documentation
Status Incomplete

Run a Sandbox

First install from NPM:

$ npm install esandex -g

Then start an instance of the Esandex server:

$ esandex
Esandex: started sandbox on port 3000

You can now navigate to various endpoints in the sandbox, such as http://localhost:3000/v1.0/accounts.

As a Package

The sandbox can be started from within your code by consuming it as a package. Firstly install into your project:

$ npm install esandex --save

Start the sandbox by creating it and instructing it to listen on the specified port:

var sandbox = require('esandex').create();

sandbox.listen(3000, function () {
  console.log('sandbox started at http://localhost:3000/');
});

Contribute

Contributions are welcome! Fork the project over on GitHub and create a pull request!