Node wrapper for the MX Atrium AP
Clone or download
newellista Merge pull request #18 from mxenabled/add-categorize-transaction-endp…
…oint

Add support for categorize_and_describe
Latest commit 1f2b7a9 Oct 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Add support for categorize_and_describe Oct 10, 2018
.eslintrc.js fix eslint rules Oct 15, 2016
.gitignore add getUsers, createUser and getUser Oct 7, 2016
.travis.yml set node version for travis Oct 11, 2016
LICENSE Initial commit Oct 10, 2016
README.md Update README.md Oct 19, 2016
index.js Add support for categorize_and_describe Oct 10, 2018
package.json Bump version Aug 2, 2018

README.md

MX Atrium

npm version Build Status

Description

This is a Node wrapper for the MX Atrium API. It is intended to be used as a helper for the implementation of a proxy server. To get an API key and Client ID, click here.

Installation

npm install mx-atrium

Usage

const Atrium = require('mx-atrium');

const AtriumClient = new Atrium.Client('API_KEY', 'CLIENT_ID', Atrium.environments.sand);

Sample Express.js route

app.get('/institutions', (request, response) => {
  AtriumClient.listInstitutions(request)
  .then(json => {
    response.json(json);
  });
});

For a complete express.js server example, click here.

Helpers

There are two constants returned with the Atrium instance, endpoints and environments.

Atrium.environments

This returns a sand and production URL that must be passed to the new client.

Atrium.endpoints

This returns an array of objects that can be used to build routes for the server.

Sample object

{
  method: 'post',
  url: '/users',
  clientMethod: 'createUser'
}