Skip to content

HilscherAutomation/netFIELD-node-sdk

Repository files navigation

netFIELD SDK Node

netFIELD-SDK-Node (node.js version >=10.x.x) and Node samples for REST API.

Installation

Install sdk through 'npm' or download folder in your project

npm install netfield-node-sdk --save

Require 'netfield-sdk-node' in your file

var netField = require('netfield-node-sdk');

Configuration

Advanced configuration options.

netField.setConfiguration({
   version: '1.0.0',
   schema: 'https', // http or https
   host: 'api.netfield.io',
   post: 443,
   headers: {
       'Content-type': 'application/json',
       'Accept': 'application/json',
       'Authorization': 'your-token'
   }
});

Token configuration.

netField.setToken('your-token'); //Done automatically by auth
netField.removeToken('your-token'); //Done automatically by revoke

Helper functions.

const token = netField.getToken();
const options = netField.getConfiguration();

Method Usage

Callbacks (old way)

const params = { email: 'my@email.de', password: 'my-password' };

netField.generateUserToken(params, function (error, data) {
    if(error){
        throw new Error(error.message);
    }
});

Promises (new way)

const params = { email: 'my@email.de', password: 'my-password' };

netField.generateUserToken(params)
    .then(data => {
        // do something
    })
    .catch(error => {
        throw new Error(error.message);
    });

Resources

  1. Auth

  2. Device

  3. Containers

  4. Organisation

  5. Tenants

  6. Users

  7. Permissions

  8. Roles

  9. EdgeOs

  10. Keys

  11. Webhooks

  12. Deployments

Tests

Setup your testing environment to localmachine and change configuration through method

netField.setConfiguration({
    version: '1.0.0',
    schema: 'https', // http or https
    host: 'api.netfield.io',
    post: 443,
    headers: {
        'Content-type': 'application/json',
        'Accept': 'application/json',
        'Authorization': 'your-token'
    }
});

Edit setings in configure file and change enviorment.js to be development

const enviorment = exports.enviorment = {
    enviorment: 'development'
}

Run tests

npm run test

Error response

Error responses are structured in following object

let error = {
    error: "Not Found" // Status message,
    message: "OrganisationId not found." // Description message
}

License

See LICENSE file in project.