HTTPS SSH

synq

Synq - JavaScript client for synq The SYNQ video API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.7.0
  • Package version: 1.7.0
  • Build date: 2016-11-15T17:50:13.381+01:00
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install synq --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/YOUR_GIT_REPO_ID then install it via:

npm install YOUR_USERNAME/YOUR_GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var Synq = require('synq');

var api = new Synq.VideoApi()

var apiKey = "apiKey_example"; // {String} 

var opts = { 
  'userdata': "userdata_example" // {String} Additional metadata that will be associated with the video
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.create(apiKey, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://api.staging.synq.fm/v1

Class Method HTTP request Description
Synq.VideoApi create POST /video/create Create a new video, optionally setting some metadata fields.
Synq.VideoApi details POST /video/details Return details about a video.
Synq.VideoApi query POST /video/query Perform a JavaScript query to return video objects matching any desired criteria.
Synq.VideoApi update POST /video/update Update a video's metadata.
Synq.VideoApi upload POST /video/upload Return parameters needed for uploading a video file.
Synq.VideoApi uploader POST /video/uploader Return embeddable url to an uploader widget

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.