belvo

Belvo Js

📕 Documentation

How to use belvo-js: https://belvo-finance.github.io/belvo-js/

If you want to check the full documentation about Belvo API: https://docs.belvo.co

Or if you want to more information about:

• Getting Belvo API keys
• Using Connect Widget
• Testing in sandbox
• Using webhooks and recurrent links

Installation

Install the package using npm

$ npm install belvo --save

Usage

var belvo = require("belvo").default;

var client = new belvo(
  'YOUR-KEY-ID',
  'YOUR-SECRET',
  'https://sandbox.belvo.co'
);

client.connect()
  .then(function () {
    client.links.list()
      .then(function (res) {
        console.log(res);
      })
      .catch(function (error) {
        console.log(error);
      });
});

Or if you prefer to use ES6 and async/await

import Client from 'belvo';

const client = new Client(
  'YOUR-KEY-ID',
  'YOUR-SECRET',
  'https://sandbox.belvo.co'
);

async function getLinks() {
  try {
    const links = await client.links.list();
    console.log(links);
  } catch (error) {
    console.log(error);
  }
}

Development

After checking out the repo, run npm install to install dependencies. Then, run npm test to run the tests.

To release a new version:

• Use npm version major|minor|patch to bump a new version.
• Create a new pull request for the new version.
• Once the new version is merged in master, create a tag matching the new version.

Linting

Make sure to run npm run lint. Otherwise the build will break.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/belvo-finance/belvo-js. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Belvo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.