@ingest/ingest-node-sdk v1.1.1

Ingest.io Node SDK

The official Ingest.io Node SDK for interfacing with Ingest.

Table of contents

• Requirements
• Getting Started
• API Documentation
  • Videos
  • Inputs
  • Profiles
  • Jobs
  • Events
  • Livestreams
  • Networks
  • Roles
  • Users
• Issues
• Development
  • Tests
• License

Requirements

• node.js -- v6.11.4 or newer

Getting Started

Getting started with the Ingest Node SDK is simple.

The Ingest Node SDK supports both callback and promise flows, and is easily integratable into your workflow. The below documentation will show usage with the callback functionality.

To use the SDK:

1. Install the SDK via npm:

npm install @ingest/ingest-node-sdk

2. Require it in your project:

  const IngestSDK = require('@ingest/ingest-node-sdk')

3. Initialize the SDK:

  const Ingest = new IngestSDK({
    token: 'Bearer ..',
  })

API Documentation

All resource methods have an optional callback parameter as the last parameter. This can be omitted and a promise flow adopted instead. The following examples contain the callback approach.

Videos

Retrieving all Videos

Ingest.Videos.getAll(headers, status, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the videos you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Search Videos

Ingest.Videos.search(input, headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Retrieving a Video

Ingest.Videos.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating a Video

Title is the only mandatory property, please check the main API documentation for a full list:

let video = {
  title: 'My video title'
}

Ingest.Videos.add(video, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Counting Videos

Returns the count of all the videos. The count will be available as a header property in the response. Resource-Count

Ingest.Videos.count(status, private, (error, data) => {
  if (error) {
    // handle error
  }

  let resourceCount = data.headers['resource-count']
  ...
})

Get a Video's thumbnails

Ingest.Videos.getThumbnails(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Get a Video's variants

Ingest.Videos.getVariants(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Adding external thumbnails to a Video

Ingest.Videos.addExternalThumbnails(id, images, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Uploading a thumbnail to a Video

  Ingest.Videos.uploadThumbnail(id, image, function(error, data) {
    if(error) {
      return res.send(error)
    }
    ...
  })

Deleting a thumbnail from a Video

Ingest.Videos.deleteThumbnail(id, thumbnailID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a Video

Ingest.Videos.update(video, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Publishing videos

This makes videos publicly available to anyone who has the video playback url

Ingest.Videos.update(ids, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting a Video

Deleting a video just puts the video in Ingest's trash, making it publicly inaccessible and set for permanent deletion a short time from now:

Ingest.Videos.delete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

If you wish to permanently delete the video immediately:

Ingest.Videos.permanentDelete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Inputs

Retrieving all Inputs

Ingest.Inputs.getAll(headers, filters, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the inputs you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Search Inputs

Ingest.Inputs.search(input, headers, filters (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Retrieving an Input

Ingest.Inputs.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating an Input

Filename is the only mandatory property, please check the main API documentation for a full list:

let input = {
  filename: 'My input filename'
}

Ingest.Inputs.add(input, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Counting Inputs

Returns the count of all the inputs. The count will be available as a header property in the response. Resource-Count

Ingest.Inputs.count((error, data) => {
  if (error) {
    // handle error
  }

  let resourceCount = data.headers['resource-count']
  ...
})

Updating an Input

Ingest.Inputs.update(input, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting an Input

Ingest.Inputs.delete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Profiles

Retrieving all Profiles

Ingest.Profiles.getAll(headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the profiles you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Search Profiles

Ingest.Profiles.search(input, headers, filters (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Retrieving a Profile

Ingest.Profiles.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating a Profile

The following fields are mandatory when creating a profile

let profile = {
  name: 'My Profile name',
  type: 'mp4',
  data: {}'
}

Ingest.Profiles.add(profile, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Counting Profiles

Returns the count of all the profiles. The count will be available as a header property in the response. Resource-Count

Ingest.Profiles.count((error, data) => {
  if (error) {
    // handle error
  }

  let resourceCount = data.headers['resource-count']
  ...
})

Updating a Profile

Ingest.Profiles.update(input, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting a Profile

Please note, default profiles cannot be deleted and locked profiles can only be deleted by admins.

Ingest.Profiles.delete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Jobs

Retrieving all Jobs

Ingest.Jobs.getAll(headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the jobs you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Retrieving a Job

Ingest.Jobs.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating a Job

The following fields are mandatory when creating a profile

let job = {
  inputs: [
    'someuuid'
  ],
  profile: 'someuuid',
  video: 'someuuid'
}

Ingest.Jobs.add(job, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Counting Jobs

Returns the count of all the Jobs. The count will be available as a header property in the response. Resource-Count

Ingest.Jobs.count((error, data) => {
  if (error) {
    // handle error
  }

  let resourceCount = data.headers['resource-count']
  ...
})

Deleting a Job

Ingest.Jobs.delete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Events

Everything you do in Ingest causes events to be made. These are just actions of things that have happened on your network.

Retrieving all events

Ingest.Events.getAll(headers, filterStatus, filterType (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the profiles you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Retrieving an Event

Ingest.Events.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Counting Events

Returns the count of all the events. The count will be available as a header property in the response. Resource-Count

Ingest.Events.count((error, data) => {
  if (error) {
    // handle error
  }

  let resourceCount = data.headers['resource-count']
  ...
})

Get Event Types

Ingest.Events.getTypes((error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Livestreams

Retrieving all Livestreams

Ingest.Livestreams.getAll(headers, status, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the livestreams you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Retrieving a Livestream

Ingest.Livestreams.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating a Livestream

Title is the only mandatory property, please check the main API documentation for a full list:

let livestream = {
  title: 'My Livestream'
}

Ingest.Livestreams.add(livestream, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a Livestream

Only the title is updatable.

Ingest.Livestreams.update(livestream, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting a Livestream

Please note, you must end your livestream before deleting it. To do so, pass true in as the end value.

Ingest.Livestreams.delete(id, end, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Networks

Retrieving all networks

Ingest.Networks.getAll(headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the networks you can access.

Retrieving a Network

Ingest.Networks.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a Network

Ingest.Networks.update(network, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Adding a Playback Key

Adds a Private Playback key to your network. The key must be in PKCS1 or PKCS8 format.

let key = {
  title: 'My Playback Key',
  key: 'MY KEY HERE'
}

Ingest.Networks.addSecureKey(id, key, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting a Playback Key

Deletes a Private Playback key from your network.

Ingest.Networks.deleteSecureKey(id, keyID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a Playback Key

Updates a Private Playback key from your network. Only the title can be updated.

Ingest.Networks.updateSecureKey(id, key, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Get a Playback Key

Gets a Private Playback key from your network.

Ingest.Networks.getSecureKeyById(id, keyID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Getting all Invoices

Gets all invoices for your network.

Ingest.Networks.getInvoices(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Getting an Invoice

Gets a single invoice for your network.

Ingest.Networks.getInvoiceById(id, invoiceID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Getting your current monthly usage

Gets your current monthly usage

Ingest.Networks.getCurrentUsage(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Inviting a User to a network

Invites the user specified to your network

Ingest.Networks.inviteUser(id, email, name, resend (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Get all Pending User Invites

Gets all pending user invites for your network.

Ingest.Networks.getPendingUsers(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Delete a Pending User Invite

Gets all invoices for your network.

Ingest.Networks.deletePendingUser(id, pendingUserID (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Linking a User to a Network

Links a specified user to the specified network

Ingest.Networks.linkUser(id, userID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Unlinking a User from a Network

Unlinks a specified user to the specified network

Ingest.Networks.unlinkUser(id, userID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Roles

Retrieving all Roles

Ingest.Roles.getAll(headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the roles you can access.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument.

Retrieving a Role

Ingest.Roles.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Creating a Role

A role requires a role name, and an array of permissions.

let role = {
  role_name: 'My Role name',
  permissions: []
}

Ingest.Roles.add(role, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a Role

Ingest.Roles.update(role, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Deleting a Role

Ingest.Roles.delete(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Users

Retrieving all Users

Only returns users on your currently authorized network

Ingest.Users.getAll(headers, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

This will return a list of all the users in your authorized network.

Sometimes, the results will be paginated. In order to access the next page, pass the value that was provided to you on the Next-Range header as an argument:

Retrieving an User

Ingest.Users.getById(id, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Updating a User

This updates the given user, only if you have permission to do so.

Ingest.Users.update(user, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Getting current User Info

Ingest.Users.getCurrentUserInfo((error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Revoking Current User

Revokes the current user's authorization token

Ingest.Users.revokeCurrentUser((error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Update Users Roles

You will only be able to update a user's roles if you have valid permissions.

Ingest.Users.updateUserRoles(id, roleIDs, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Transfer User Authorship

Transfers all of a user's content to another user.

Ingest.Users.transferUserAuthorship(originalID, newID, (error, data) => {
  if (error) {
    // handle error
  }

  ...
})

Issues

If you encounter any issues using the Ingest Node SDK, please search the existing issues first before opening a new one.

Please include any information that may be of assistance with reproducing the issue.

Development

To modify the source of the Ingest SDK, clone the repo.

npm install

Develop in a topic/feature branch, not master.

Running Tests

To run the unit tests, use:

npm run test

To watch the unit tests, use:

npm run test:watch

License

This SDK is distributed under the MIT License, see License for more information.