@5app/digital-hub-api

API for interacting with a Digital Hub

Usage no npm install needed!

<script type="module">
  import 5appDigitalHubApi from 'https://cdn.skypack.dev/@5app/digital-hub-api';
</script>

README

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 request-promise.

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

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