Losant Javascript REST API Client

Build Status

The Losant REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.

This client works both in browsers and node.js (v0.12 and newer), and supports both callbacks and promises. It uses Axios under the covers for the actual HTTP communication.

Installation

The latest stable version is available in NPM and can be installed using

npm install --save losant-rest

Example

Below is a high-level example of using the Losant JavaScript REST API client to authenticate against the Losant Platform and report state for a device.

var api = require('losant-rest');
var mySensor = require('./my-analog-sensor');

var client = api.createClient();

client.auth.authenticateDevice({ credentials: {
  deviceId: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret'
}}).then(function (response) {
  client.setOption('accessToken', response.token);
  var appId = response.applicationId;

  var state = { data: { temperature: mySensor.read() } };
  return client.device.sendState({
    deviceId: 'my-device-id',
    applicationId: appId,
    deviceState: state
  });
})
.then(function (response) {
  console.log(response); // { success: true }
})
.catch(function (error) {
  console.error(error);
});

API Documentation

var client = api.createClient({ accessToken: undefined, url: 'https://api.losant.com' })

The losant-rest module exposes a single function named createClient which returns a client instance. It takes the following options:

accessToken
The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the Auth methods, or can be created for a particular application through applicationApiTokens.
url
The url of the Losant API - by default .

Client

A client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.

Functions

setOption(name, value)
The setOption function can be used to change any of the options currently set on the client, such as the access token.
getOption(name)
The getOption function can be used to retrieve the current value of any of the options set on the client instance.

Resources

Each of the following is a property on the client instance, and wraps the actions for that particular resource. See each resource documentation file for more information.

application
Contains all of the actions that can be performed against a single Application, which include things like getting info on an application or modifying an application.
applicationApiToken
Contains all the actions that can be performed against a single Api Token belonging to an application - for instance, getting info on a single token or revoking a token.
applicationApiTokens
Contains all of the actions that can be performed against the collection of Api Tokens belonging to an Application - such as listing all tokens or creating a new token.
applicationCertificate
Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.
applicationCertificateAuthorities
Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.
applicationCertificateAuthority
Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.
applicationCertificates
Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.
applicationDashboard
Contains all the actions that can be performed against a single Application Dashboard - for instance, things like getting info on a dashboard or modifying a dashboard.
applicationDashboards
Contains all of the actions that can be performed against the collection of Application Dashboards belonging to an Application - such as listing all dashboards or creating a new dashboard.
applicationKey
Contains all the actions that can be performed against a single Application Key - for instance, getting info on a single key or revoking a key.
applicationKeys
Contains all of the actions that can be performed against the collection of Application Keys belonging to an Application - such as listing all keys or creating a new key.
applications
Contains all of the actions that can be performed against the set of Applications that the currently authenticated user has access to - such as listing the applications or creating a new application.
applicationTemplate
Contains all the actions that can be performed against a single Application Template - for instance, getting info on a single template.
applicationTemplates
Contains all of the actions that can be performed against the collection of Application Templates - such as listing all templates or categories.
auditLog
Contains all of the actions that can be performed against a single Audit Log that belongs to an organization - such as viewing a log.
auditLogs
Contains all of the actions that can be performed against the set of Audit Logs that belong to an organization - such as listing the logs.
auth
Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.
credential
Contains all the actions that can be performed against a single Service Credential, such as updating a credential or removing a credential.
credentials
Contains all of the actions that can be performed against the set of Service Credentials that the currently authenticated user has access to - such as listing the credentials or creating a new credential.
dashboard
Contains all of the actions that can be performed against a single Dashboard, which include things like getting info on a dashboard or modifying a dashboard.
dashboards
Contains all of the actions that can be performed against the set of Dashboards that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.
data
Contains the actions for querying against historical Device data across an Application.
dataTable
Contains all the actions that can be performed against a single Data Table - for instance, getting info on a single data table or modifying the columns of a data table.
dataTableRow
Contains all the actions that can be performed against a single row inside of a Data Table - for instance, getting the contents of a row, or modifying a row.
dataTableRows
Contains all of the actions that can be performed against the collection of rows that make up a Data Table - such as querying for rows in that table, or adding a new row to the table.
dataTables
Contains all of the actions that can be performed against the collection of Data Tables belonging to an Application - such as listing all data tables or creating a new data table.
device
Contains all the actions that can be performed against a single Device - for instance, getting info on a single device or reporting the current state of a device.
deviceRecipe
Contains all the actions that can be performed against a single Device Recipe, which include things like removing a device recipe or creating a device from a device recipe.
deviceRecipes
Contains all the actions that can be performed against the collection of Device Recipes belonging to an Application - such as listing recipes or creating a new recipe.
devices
Contains all of the actions that can be performed against the collection of Devices belonging to an Application - such as listing all devices or sending a command to a set of devices.
edgeDeployment
Contains all the actions that can be performed against a single Edge Deployment belonging to an Application - such as retrieving information on a single deployment.
edgeDeployments
Contains all the actions that can be performed against the collection of Edge Deployments belonging to an Application - such as listing deployments or creating a new deployment.
embeddedDeployment
Contains all the actions that can be performed against a single Embedded Deployment belonging to an Application - such as retrieving information on a single deployment.
embeddedDeployments
Contains all the actions that can be performed against the collection of Embedded Deployments belonging to an Application - such as listing deployments or creating a new deployment.
event
Contains all the actions that can be performed against a single Event, such as commenting on or changing the state of an event.
events
Contains all the actions that can be performed against the collection of Events belonging to an Application - such as listing open events or creating a new event.
experience
Contains all the actions that can be performed against an application Experience, such as bootstrapping or clearing resources.
experienceDomain
Contains all the actions that can be performed against a single Experience Domain, such as updating SSL certificate information.
experienceDomains
Contains all the actions that can be performed against the collection of Experience Domains belonging to an Application - such as listing domains or creating a new domain.
experienceEndpoint
Contains all the actions that can be performed against a single Experience Endpoint, such as updating route information.
experienceEndpoints
Contains all the actions that can be performed against the collection of Experience Endpoints belonging to an Application - such as listing endpoints or creating a new endpoint.
experienceGroup
Contains all the actions that can be performed against a single Experience Group, such as updating member information.
experienceGroups
Contains all the actions that can be performed against the collection of Experience Groups belonging to an Application - such as listing groups or creating a new group.
experienceSlug
Contains all the actions that can be performed against a single Experience Slug, such as changing the associated version.
experienceSlugs
Contains all the actions that can be performed against the collection of Experience Slugs belonging to an Application - such as listing slugs or creating a new slug.
experienceUser
Contains all the actions that can be performed against a single Experience User, such as changing their email or password.
experienceUsers
Contains all the actions that can be performed against the collection of Experience Users belonging to an Application - such as listing users or creating a new user.
experienceVersion
Contains all the actions that can be performed against a single Experience Version, such as modifying the description.
experienceVersions
Contains all the actions that can be performed against the collection of Experience Versions belonging to an Application - such as listing versions or creating a new versions.
experienceView
Contains all the actions that can be performed against a single Experience View, such as modifying the body template.
experienceViews
Contains all the actions that can be performed against the collection of Experience Views belonging to an Application - such as listing views or creating a new view.
file
Contains all the actions that can be performed against a single File, such as moving, renaming, or deleting.
files
Contains all the actions that can be performed against the collection of Files belonging to an Application - such as listing files or uploading a new file.
flow
Contains all the actions that can be performed against a single Workflow, such as enabling or disabling a workflow, or triggering a virtual button in the workflow.
flows
Contains all the actions that can be performed against the collection of Workflows belonging to an Application - such as listing the workflows or creating a new workflow.
flowVersion
Contains all the actions that can be performed against a single Workflow Version, such as enabling or disabling a workflow version, or updating the version notes.
flowVersions
Contains all the actions that can be performed against the collection of Workflow Versions belonging to a Workflow - such as listing the versions or creating a new version.
instance
Contains all the actions that can be performed against a single Instance, which include things such as updating report configuration or defaults.
instanceApiToken
Contains all the actions that can be performed against a single Instance API Token - for instance, getting info on a single token or revoking a token.
instanceApiTokens
Contains all the actions that can be performed against the collection of Instance API Tokens belonging to an Instance - such as listing tokens or creating a new token.
instanceAuditLog
Contains all of the actions that can be performed against a single Audit Log belonging to an Instance - such as viewing a log.
instanceAuditLogs
Contains all of the actions that can be performed against the set of Audit Logs belonging to an Instance - such as listing the logs.
instanceCustomNode
Contains all the actions that can be performed against a single Instance Custom Node - for instance, getting info on a single custom node or modifying a custom node.
instanceCustomNodes
Contains all the actions that can be performed against the collection of Instance Custom Nodes belonging to an Instance - such as listing custom nodes or creating a new custom node.
instanceMember
Contains all the actions that can be performed against a single Instance Member, which include things such as updating the role or removing the member.
instanceMembers
Contains all the actions that can be performed against the collection of Instance Members belonging to an Instance - such as listing members or adding a new member.
instanceNotificationRule
Contains all the actions that can be performed against a single Instance Notification Rule, which include things such as updating the threshold or the targets.
instanceNotificationRules
Contains all the actions that can be performed against the collection of Instance Notification Rules belonging to an Instance - such as listing rules or adding a new rule.
instanceOrg
Contains all the actions that can be performed against a single Instance Organization, which include things such as modifying limits.
instanceOrgInvite
Contains all the actions that can be performed against a single Instance Organization Invite, which include things such as revoking the invite.
instanceOrgInvites
Contains all the actions that can be performed against the collection of Instance Organization Invites belonging to an Organization in an Instance - such as listing invites or sending a new invitation.
instanceOrgMember
Contains all the actions that can be performed against a single Instance Organization Member, which include things such as changing the role or removing the membership.
instanceOrgMembers
Contains all the actions that can be performed against the collection of Instance Organization Members belonging to an Organization in an Instance - such as listing members or adding new members.
instanceOrgs
Contains all the actions that can be performed against the collection of Instance Organizations belonging to an Instance - such as listing organizations or adding a new organization.
instances
Contains all the actions that can be performed against the collection of Instances that the currently authenticated user has access to - such as listing instances.
instanceSandbox
Contains all the actions that can be performed against a single Instance Sandbox - for instance, getting info on a single sandbox or deleting the sandbox.
instanceSandboxes
Contains all the actions that can be performed against the collection of Instance Sandboxes belonging to an Instance - such as listing sandboxes.
integration
Contains all the actions that can be performed against a single Integration, which include things like removing an integration or updating integration configuration.
integrations
Contains all the actions that can be performed against the collection of Integrations belonging to an Application - such as listing integrations or creating a new integration.
me
Contains the actions for operating against the currently authenticated User such as changing the password or linking against external services.
notebook
Contains all the actions that can be performed against a single Notebook, which include things like removing a notebook or executing a notebook.
notebooks
Contains all the actions that can be performed against the collection of Notebooks belonging to an Application - such as listing notebooks or creating a new notebook.
org
Contains all the actions that can be performed against a single Organization, things like inviting a user to the organization, or modifying the organization.
orgInvites
Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.
orgs
Contains all of the actions that can be performed against the set of Organizations that the currently authenticated user has access to - such as listing the organizations or creating a new organization.
resourceJob
Contains all the actions that can be performed against a single Resource Job, such as executing the job.
resourceJobs
Contains all the actions that can be performed against the collection of Resource Jobs belonging to an Application - such as listing resource jobs or creating a new resource job.
userApiToken
Contains all the actions that can be performed against a single User API Token, such as revoking the token.
userApiTokens
Contains all the actions that can be performed against the collection of User API Tokens belonging to the currently authenticated user - such as listing tokens or creating a new token.
webhook
Contains all the actions that can be performed against a single Webhook, for instance modifying the verification settings or removing the webhook.
webhooks
Contains all the actions that can be performed against the collection of Webhooks belonging to an Application - such as listing the webhooks or creating a new webhook.

Most popular functions for losant-rest

To help you get started, we’ve selected a few losant-rest examples, based on popular ways it is used in public projects.

losant-rest.createClient