APPLICATION PROGRAMMING INTERFACE (API)

Build your own streaming application by using the Videolinq white label API version 1.0. The Videolinq Live Streaming API version 1.0 provides a programmer interface for creating Users, Stream Jobs, Endpoints, Schedulers, and Players programmatically. The API accepts JSON POST requests and returns responses as JSON.

 

The API is language agnostic and can be used with any programming language capable of sending HTTP POST requests and parsing JSON data. The following is a reference for using the API, and the operations available to you or your application developer.

 

Videolinq accounts with API access share a "bucket" of available Stream Jobs, Endpoints, output hours, and data transfer pool. Accounts with API access can create an unlimited number of Sub-Users, Schedulers, and Players. It is the responsibility of the programmer using the API feature on a Videolinq account to assign and limit the number of Stream Jobs, Endpoints, output hours and data transfer their Sub-Users can use.

 

The following features are managed by the Videolinq API:

 

  • User/Create new User and assign credentials.

  • User/Edit User.

  • User/Allow User to publish video and or closed captioning.

  • User/Remove User.

  • StreamJob/Crete new StreamJob.

  • StreamJob/Send a RTMP stream with unique stream key (stream id).

  • StreamJob/Use the StreamJob credentials to send closed captioning data.

  • StreamJob/Point to stream HDS/HLS paths.

  • StreamJob/Edit StreamJob.

  • StreamJob/Remove StreamJob.

  • Scheduler/Create new Scheduler.

  • Scheduler/Edit existing Scheduler.

  • Scheduler/Remove Scheduler.

  • Endpoint/Create new Endpoint.

  • Endpoint/Edit existing Endpoint.

  • Endpoint/Remove Endpoint.

  • Statistics/Output hours used per Account/User/Stream.

  • Statistics/Data transferred used per Account/User/Stream.

 

 

API Version and Access

In January 2019 we release the Videolinq API version 1.0 (as PDF format). This version of the API can access and manage Videolinq version 2.0. To use the API you will need an active service account on Videolinq version 2.0, and a unique key that identifies your account when API calls reach Videolinq.

In June 2020 we released Videolinq version 3.0. A future API version 2.0 will be available to access this version of Videolinq in mid-2021. The main differences between Videolinq version 2.0 and version 3.0 is the support of webcam as source signal, the introduction of OAuth authentication to secure instant connections to some social media platforms, and features like nDVR and ABR functionality. We have also migrated the Videolinq player to a new build that does not support HDS streaming anymore.