Guides
  1. SDKs

JavaScript SDK

The JavaScript SDK is the official client for the Nomad Media platform. It wraps the Portal and Admin APIs with idiomatic JavaScript methods for assets, folders, search, live channels, collections, and more.

JavaScript SDK

The JavaScript SDK is the official client for the Nomad Media platform. It wraps the Portal and Admin APIs with idiomatic JavaScript methods for assets, folders, search, live channels, collections, and more.

Get started

  1. Install the SDK and add it to your project.
  2. Authenticate with a real username and password.
  3. Browse the API by area below, then follow a recipe for an end-to-end task.

Quick start

import NomadMediaSDK from "<path-to-sdk>/src/sdk.js";

const config = {
    serviceApiUrl: "https://nomad-admin-api.yourdomain.com/api",
    apiType: "admin",            // "admin" | "portal"
    username: "<from-config>",   // never hard-code
    password: "<from-config>",   // never hard-code
    debugMode: false,
};

const sdk = new NomadMediaSDK(config);
const asset = await sdk.getAsset("<asset-id>"); // login happens here on first call

Browse the API by area

Recipes

Task-oriented walkthroughs that combine several operations:

Reference