\n\n## 📕 Documentation\nHow to use `belvo-js`: https://belvo-finance.github.io/belvo-js/\n\nIf you want to check the full documentation about Belvo API: https://developers.belvo.com\n\nOr if you want to more information about:\n* [Getting Belvo API keys](https://developers.belvo.com/docs/get-started-in-5-minutes#get-your-belvo-api-keys)\n* [Using Connect Widget](https://developers.belvo.com/docs/connect-widget)\n* [Testing in sandbox](https://developers.belvo.com/docs/test-in-sandbox)\n* [Using webhooks and recurrent links](https://developers.belvo.com/docs/webhooks)\n\n## Installation\nInstall the package using npm\n```\n$ npm install belvo --save\n```\n\n## Usage (create link via widget)\n\nWhen your user successfully links their account using the [Connect Widget](https://developers.belvo.com/docs/connect-widget), your implemented callback funciton will return the `link_id` required to make further API to retrieve information.\n\n\n```javascript\nvar belvo = require(\"belvo\").default;\n\nvar client = new belvo(\n 'YOUR-KEY-ID',\n 'YOUR-SECRET',\n 'sandbox'\n);\n\n// Get the link_id from the result of your widget callback function\nconst linkId = resultFromCallbackFunction.id\n\nfunction retrieveAccounts (linkId) {\n return client.connect().then(function () {\n return client.accounts.retrieve(linkId)\n .then(function (response) {\n return(response);\n })\n .catch(function (error) {\n console.error(error)\n });\n })\n}\n\n```\n\n\nOr if you prefer to use ES6 and async/await\n\n```javascript\nimport Client from 'belvo';\n\nconst client = new Client(\n 'YOUR-KEY-ID',\n 'YOUR-SECRET',\n 'sandbox'\n);\n\n// Get the link_id from the result of your widget callback function\nconst linkId = result_from_callback_function.id\n\nasync function retrieveAccounts(linkId) {\n try {\n await client.connect()\n return await client.accounts.retrieve(linkId);\n } catch (error) {\n console.log(error);\n }\n}\n```\n\n\n## Usage (create link via SDK)\n\nYou can also manually create the link using the SDK. However, for security purposes, we highly recommend, that you use the [Connect Widget](https://developers.belvo.com/docs/connect-widget) to create the link and follow the **Usage (create link via widget)** example.\n\n\n```javascript\nvar belvo = require(\"belvo\").default;\n\nvar client = new belvo(\n 'YOUR-KEY-ID',\n 'YOUR-SECRET',\n 'sandbox'\n);\n\nfunction registerLinkAndRetrieveAccounts () {\n return client.connect().then(function () {\n return client.links.register('erebor_mx_retail', 'bnk1002', 'full')\n .then(function (response) {\n return client.accounts.retrieve(response.id);\n })\n .then(function (response) {\n return response;\n })\n .catch(function (error) {\n console.error(error)\n });\n })\n}\n```\nOr if you prefer to use ES6 and async/await\n\n```javascript\nimport Client from 'belvo';\n\nconst client = new Client(\n 'YOUR-KEY-ID',\n 'YOUR-SECRET',\n 'sandbox'\n);\n\nasync function registerLinkAndRetrieveAccounts () {\n try {\n await client.connect()\n const link = await client.links.register('erebor_mx_retail', 'bnk1006', 'supersecret');\n console.log(link)\n return await client.accounts.retrieve(link.id);\n } catch (error) {\n console.log(error);\n }\n}\n```\n\n## Development\nAfter checking out the repo, run `npm install` to install dependencies. Then, run `npm test` to run the tests.\n\nTo release a new version:\n- Create a new branch from master.\n- Use `npm version major|minor|patch` to bump a new version.\n- Create a new pull request for the new version.\n- Once the new version is merged in `master`, create a `tag` matching the new version.\n\n### Linting\nMake sure to run `npm run lint`. Otherwise the build will break.\n\n## Contributing\n\nBug 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](https://github.com/belvo-finance/belvo-js/blob/master/CODE_OF_CONDUCT.md).\n\nIf you wish to submit a pull request, please be sure check the items on this list:\n- [ ] Tests related to the changed code were executed\n- [ ] The source code has been coded following [the OWASP security best practices](https://owasp.org/www-pdf-archive/OWASP_SCP_Quick_Reference_Guide_v2.pdf).\n- [ ] Commit message properly labeled\n- [ ] There is a ticket associated to each PR.\n\n\n## Code of Conduct\n\nEveryone interacting in the Belvo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/belvo-finance/belvo-js/blob/master/CODE_OF_CONDUCT.md).\n","readmeFilename":"README.md"}
![\"npm\"](\"https://img.shields.io/npm/v/belvo?style=for-the-badge\")
\n ![\"Github](\"https://img.shields.io/github/workflow/status/belvo-finance/belvo-js/Tests?style=for-the-badge\")
\n ![\"Coveralls](\"https://img.shields.io/coveralls/github/belvo-finance/belvo-js?style=for-the-badge\")
\n ![\"CodeClimate](\"https://img.shields.io/codeclimate/maintainability/belvo-finance/belvo-js?style=for-the-badge\")
\n