Ubidots class

Ubidots JavaScript library's main class.

Definition

The Ubidots class is the library's entry point. It provides subclasses to interact with each supported entity in the API. For example, to use the devices API, use:

Ubidots.devices.<methods>

The methods exposed by the devices subclass let you use the full devices API.

Ubidots class properties

Property	Description
devices	Provides access to devices API.
variables	Provides access to variables API.
dashboards	Provides access to dashboards API.
users	Provides access to users API.
organizations	Provides access to organizations API.

In this section, these properties are referred to as entity or entities. This reflects the part of the API they interact with. For example, device entity refers to the Ubidots class property that interacts with the devices API.

Ubidots class methods

Method	Arguments	Description
authenticate	A valid Ubidots token.	Authenticates with the Ubidots API.
setBaseUrl	Custom API Host	Configures a custom base URL for all API requests.

Usage

Authentication

Authentication with a valid Ubidots token is required to use the library:

Ubidots.authenticate('BBFF-ubidots-token');

Custom API Host

Configure a custom base URL when connecting to a dedicated Ubidots deployment:

Ubidots.setBaseUrl('https://custom.api.ubidots.com/api');

Instantiation

This class is implemented as a singleton and is instantiated when exported. You do not need to create an instance. Use it directly:

// Import the class
const { Ubidots } = require('@ubidots/ubidots-javascript-library');
// Call the 'authenticate' method without instantiating 'Ubidots' first
Ubidots.authenticate('ubidots-valid-token');

General syntax

The Ubidots class exposes its methods through entities for specific parts of the API, such as devices or variables. Use the following syntax:

Ubidots.<entity>.<getMethod>([args]);

Filters syntax

Field filtering is available for each entity through the following syntax:

Ubidots.<entity>.<filterMethod>(args).<getMethod>([args]);

Here:

• <entity> is any of the valid entities.

• <filterMethod> is either of these 2 methods:

  • where()

  • addRawParams()

• <getMethod> is any of the following methods used to retrieve entities:

  • all()

  • get()

  • first()

  • paginate()

Neither where nor addRawParams sends a request to the API. They only build the URL with the corresponding query parameters. To perform the request, chain any of the <getMethod>s after the filter statements.