VHX API Client – Node.js
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.jshintrc
CHANGELOG.md
LICENSE
README.md
VERSION
package.json

README.md

VHX Node.js API Client

API applications can be created in the VHX admin or by emailing api@vhx.tv

Installation

npm install vhx

Documentation

Documentation, including a step-by-step tutorial is available on the VHX Developer Docs site. For Full API reference go here.

Getting Started

Before requesting your first resource, you must setup your instance of the VHX Client:

var vhx = require('vhx')('your VHX API key');

Every resource method has two arguments. The first argument is an options object or identifier and the second, an optional callback:

// example customer create
vhx.customers.create({
  email: 'customer@email.com',
  name: 'First Last'
}, function(err, customer){
  // err, = error is false if no error occurred
  // customer = the created customer object
});

Resources & methods

products

customers

videos

collections

authorizations

analytics