JS Treezor Client

This library is a HTTP javascript client on top of Treezor Web API, to be used on node.js server.

Getting Started 🚀

NB: you first need first to get API credentials from Treezor to start using it.

To start, simply add the module:

npm install js-treezor-client

Then set it up with your credentials:

const TreezorClient = require('js-treezor-client');

const client = new TreezorClient({
  apiUrl: 'https://sandbox.treezor.com/v1/index.php',
  accessToken: 'YOUR_TOKEN_DELIVERED_BY_TREEZOR', // Store it securely ;)
});

And you are good to go. For instance, here is an example to retrieve all the users on your account:

client.getUsers()
.then(result => console.log(result))
.catch(error => console.log(error));

Check the folder /src/api-methods to see all methods available at the moment.

That's all ;)

With async/await

You may instead use async/await :

const TreezorClient = require('js-treezor-client');

const client = new TreezorClient({
  apiUrl: 'https://sandbox.treezor.com/v1/index.php',
  accessToken: 'YOUR_TOKEN_DELIVERED_BY_TREEZOR',
});

const getUsers = async () => {
  try {
    const result = await client.getUsers();
    console.log(result);
  } catch(error) {
    console.log(error);
  }
}

Callback

You may specify an optionnal callback function, like so:

client.getWallets((err, result) => console.log(result));

Contributions 🎡

I used to work on a project based on Treezor API. And it was not simple everyday :)

So I wanted to share this work to help others go faster in integrating the API and concentrate on what matters. It does not cover the whole API, and it surely needs some improvements and updates (especially to add API methods).

So contributions will be much appreciated, and may help others in the future too !

Testing

A test example using Jest framework is available in the folder /tests. It illustrates the validation of an endpoint against a Json schema.

After cloning this repository, from the root folder:

yarn install

Replace the 'accessToken' by your own token in the test file .

Finally, laucnh tests:

jest

Some endpoints are documented with JsonSchema, which is a pretty useful format to validate Json.

These schemas do not replace the official documentation but may be usefull to complete it (ie add missing information or test endpoints). Feel free to enrich them while if you use this library.