Ubidots class

Ubidots JavaScript library's main class.

Definition

The Ubidots class is the entrypoint of the library, providing sub-classes for interacting with each particular supported entity from the API. For example, to use the devices API you can do:

Ubidots.devices.<methods>

Here, the methods exposed by the devices sub-class allow you to consume the whole 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.

From now on, these properties will be addressed as entity or entities to reflect the fact that they enable interacting with that part (entity) of the API. With this in mind, device entity refers to the property of the Ubidots class that allows interacting 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 using a valid Ubidots token is mandatory to use the library:

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

Custom API Host

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

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

Instantiation

This class is implemented as a singleton which is instantiated when it is exported, thus, there is no need for creating an instance of it. Instead, you must use it directly:

// Import the class
const { Ubidots } = require('@ubidots/ubidots-javascript-library');
// Call 'authenticate' method with no prior instantation of 'Ubidots'
Ubidots.authenticate('ubidots-valid-token');

General syntax

As stated before, the Ubidots class exposes its methods through entities for a particular part of the API such as devices or variables, thus providing 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> Either of the below methods to retrieve entities:

  • all()

  • get()

  • first()

  • paginate()

Neither where nor addRawParams methods perform the request to the API, they just build the URL with the corresponding query params. In order to actually perform the request, it is required to concatenate a calling to any of the <getMethods> after the filter statements.