@5app/digital-hub-api

v0.3.1
API for interacting with a Digital Hub

Digital Hub NodeJS API

Greenkeeper badge Known Vulnerabilities Coverage Status CircleCI

A NodeJS API for interoperating with a Digital Hub

Samples

The samples folder highlights how the API can be used to automate and report operations with a Digital Hub.

Core API

Create an instance of the hub

const Hub = require('@5app/digital-hub-api');

constructor

The constructor defines the environment and user credentials

const hub = new Hub({
    tenant,
    username,
    password,
});

api

This makes a request using node-fetch.

await hub.api({
    path: 'query/assets',
    qs: {
        fields: ['id', 'name'],
        filters: {
            parent_id: 13123,
        },
    },
});

Note: Docs on the available HTTP endpoints, methods and parameters are in development.

npm i @5app/[email protected]

Metadata

  • ISC
  • >=12.0.0
  • MrSwitch
  • released 6/9/2021

Downloads