Unofficial Ubidots NodeJS API Client

Node.js API Client for Ubidots

Prerequisites

• Node.JS >=v8

Installation

npm install ubidots-node

Usage

Initializing Library:

constUbidots=require('ubidots-node');constclient=Ubidots.create(Ubidots.ApiBase.Educational);// Authorize API with an API Keyawaitclient.authorize(API_KEY);// or alternatively using a pre-generated API Tokenclient.token=API_TOKEN;// Obtain UTC timestampconst{data: now}=awaitubitods.api('utils')// API namespace.endpoint('utc-timestamp')// API endpoint.call();// Pass parameters/options/dataconsole.log('UTC Timestamp',now);// Generate API token using API Keyconst{data: token}=awaitubitods.api('auth')// API namespace.endpoint('obtainToken')// API endpoint.call(apiKey='your-api-key');// Pass parameters/options/dataconsole.log('API Token',token);

Available APIs:

• auth - Authentication
• organization - Missing docs
• user - Missing docs
• datasource - Datasources
• dashboard - Missing docs
• device - Devices
• variable - Variables
• utils - Utils

Official API Documentation: https://ubidots.com/docs/sw/

For usage examples see test/ folder

Testing

UBIDOTS_API_KEY='xxxx' UBIDOTS_TOKEN='xxxx' npm test

Debugging

For debugging purpose the debug npm module is used.

Example of using the debug feature:

DEBUG='ubidots-node:*' npm test

Roadmap

• Complete API definition
• Add missing tests
• Add payload validation
• Find missing docs (Ubidots support?)