accuras v2.2.22

accuras SDK

A Node.js module for the accuras API.

Installation

npm install accuras 

Usage

import * accuras from "accuras"

import {authenticate, api} from "accuras"

var accuras = require("accuras")

Authentication

Using account credentials

import {authenticate} from "accuras"

authenticate(email, password)
    .then(token => {
        //Do something with JWT
    })
    .catch(error => {
        // Authentication failed
    })

Using access token

accuras.accessToken = MY_TOKEN

Thing Types

Create

import {api} from "accuras"

api.things.types
    .create({
        name: "My Thing Type",
        geoJsonObjectType: "Point",
        capabilities: ["Positioning", "Sensing"],
    })
    .then(created => {
        //Do something with created object
    })
    .catch(error => {
        // Handle API error
    })

Query

import {api} from "accuras"

api.things.types
    .search({
        name: string,
        id: string,
    })
    .then(results => {
        // Do something with results
    })
    .catch(error => {
        // Handle API error
    })

Delete

import {api} from "accuras"

api.things.types
    .delete(myThingType)
    .then(() => {
        // Object deleted successfully
    })
    .catch(error => {
        // Handle API error
    })

Raw requests

Custom requests can be made to the API by specifying path, method and request body.

import {api} from "accuras"

api.raw("/v1/path/to/somewhere")
    .method("POST")
    .body(requestBody)
    .result(data => {
        // Do something with result
    })
    .catch(error => {
        // Handle API error
    })

API errors

Errors always come in a fixed format indicating the source of conflict.

{
    timestamp: number [Time of request]
    status: number [HTTP status]
    path: string [Target destination]
    message: string [Human-readable info]
}