Skip to main content

Getting started

Setting up the x-bees-connect Client is a straightforward process. Follow the steps below to integrate the SDK into your project.

Installation​

To install the x-bees-connect Client in your project, use either Yarn or npm. Open your terminal and run one of the following commands in your project directory:

yarn add @wildix/xbees-connect

or

npm install @wildix/xbees-connect

This installs the x-bees-connect package and its dependencies.

Initialization​

Once the package is installed, initialize the x-bees-connect Client in your application. Import the library and create an instance of the client as follows:

import Client from "@wildix/xbees-connect";

const xBeesClient = Client.getInstance();

console.log(xBeesClient.version());

This initialization step provides you with a client instance that you can use to interact with the x-bees platform.

Note: Ensure that you have the necessary API keys or authentication tokens required by x-bees, and follow any specific configuration steps outlined by x-bees for your application.

With the x-bees-connect Client installed and initialized, you are ready to start incorporating its features into your application. Continue exploring the API Reference to understand the available functions and methods provided by the SDK.