Skip to main content

Javascript SDK

This page has all the information needed to install and setup the BLOOCK's SDK for Javascript. If you are looking for documentation related to an specific functionality, please refer to it's specific section.

Requirements​

To run the SDK for Javascript you will need:

  • Node version >= 12
  • NPM version >= 6.4.1
tip

Please refer also to OS support for current operating system requirements

Installation​

The Javascript SDK is available through NPM, to install it, you can run the following command:

npm install @bloock/sdk --save

Set up​

To start working with most of the functionalities of our SDKs, you will need an API Key. Please, follow the instructions of Create an API Key to get one.

Here's the code needed to properly configure the SDK Client with the API Key:

import { Bloock } from '@bloock/sdk';

Bloock.setApiKey(process.env['API_KEY']!);