remot3it

v3.3.1
remot3.it API wrapper
remot3.it api

remot3it.js

A JavaScript library that wraps the remot3.it APIs to make your life easier.

Usage

npm install --save remot3it

Now you can import the library, initialize it and start making requests to the API. All methods return Promises, so you can use async/await or traditional promises as you prefer.

import Remot3it from 'remot3it'

// Configure an instance of the remot3.it client
const remot3it = new Remot3it({
  // Authenticate using your developer key:
  developerKey: '...your developer key here...',

  // or, use an access key:
  accessKey: '...your access key here...',

  // or even a token:
  token: '...an auth token...',

  // Optional: Configure the host:
  host: 'https://api.remot3.it/apv/v24.41',
})

// Login (your first step)
await remot3it.login(email, password)

// Search for your devices
// This will do a fuzzy search for any device with the devicename of `AWS*`:
const devices = await remot3it.devices('AWS')
console.log(devices)

Setup

Install nvm and then run:

# Install and use the preferred version of node
nvm install
nvm use

# Install dependencies
npm install

# Run development server
npm start
npm i remot3it

Metadata

  • MIT
  • Whatever
  • Dana Woodman
  • released 8/30/2018

Downloads

Maintainers