Developers

The developers here at Overlay.TV use our own API every day in many interesting ways; to customize the interactivity of the player, generate custom reports, enable custom objects as Overlays, and more. We are now opening up that API to the online video community. In addition to the API, you can also use the Overlay.TV Player SDK to do even more with our Overlay player and technology.

Why do this?

Company A is looking at adding an online video experience to their site. They are committed to delivering a unique experience online, but do not want to spend the money to build a custom player from the ground up. So they come to you, the developer, with the problem. As a developer, you can now focus on the back-end, reporting, user registration, and implementation throughout the site. The Overlay.TV API and Player SDK will allow you to rapidly build out a solution that is very easy to modify and design from the ground up, and engage users in a much more immersive experience.

API – Getting A Key

When you are ready to start working with the Overlay.TV API you’ll need to get an API key. In order to authenticate yourself and secure your application this key must be passed along with each Overlay.TV call. Get started by creating an account here, and then request the key by emailing your Overlay.TV user name to developer@overlay.tv. The key will be attached to that account name.

Overlay.TV Platform API Documentation

The platform API is a simple restful interface that provides access to and from data and functions based on your application interactions with Overlay.TV. You can get access to this data through XML or you can use serialized PHP. Full documentation on the Overlay.TV API is located here.

Platform API Sample Applications

Hello World example & library in PHP: example-php.zip

Hello World example & library in Ruby: example-ruby.zip

Player SDK

Player SDK v1.0 (Test Player, Sample Apps, API documentation, framework library, widget template): overlay.tv-player-sdk-v1.0.1.zip

Tutorial on creating a widget using the Player SDK: Part 1, Part 2

Questions? Contact our dev team at developer@overlay.tv.