@nomad-media/full NPM

Nomad Media Full

This package contains the full version of the Nomad Media SDK. It includes all the methods of the SDK.

Minimum Requirements

Node.js 12.0.0

Installation

To use the Nomad SDK, download the npm nomad-media-npm.

npm install @nomad-media/full

Then to import it, you can either use the default version, or the debug version. The difference is that the debug version isn't compressed and has more documentation and named parameters.

To use the default version use:

import NomadMediaSDK from "@nomad-media/full";

To use the debug version user:

import NomadMediaSDK from "@nomad-media/full/debug";

To initialize the sdk, call the NomadMediaSDK class as shown below:

const SDK = NomadMediaSDK(config);

Configure Environmental Variables

Follow this format for the config:

const config = {
    "username": "username",
    "password": "password",
    "serviceApiUrl": "serverApiUrl",
    "apiType": "admin",
    "debugMode": true
};

serviceApiUrl: Specifies the url of the server you are trying to connect to.

apiType: Specifies whether the function you are trying to run is admin or portal.

debugMode: Specifies when running functions, whether of not to print api call information.

You are now ready to use the SDK in your project.

📘 Contact: Make sure to contact Nomad Media support to get username, password, and url for your enviromnent.
🚧 Make sure to keep your configuration options secret and do not share them publicly.