Core API

The Core API is the foundation of The HeyWatch service. You can do everything you want, even really complex tasks with it. If you need something really specific, this is the way to go.

Our API is based on REST principles and is compatible with all the languages. You just have to make an HTTP request to the right resource and the right describing method, it’s that simple. The URL to request is always the same: https://heywatch.com.

Resources

The Core API is divided into many resource:

Download: Transfer a video from your server (FTP/HTTP) to HeyWatch for encoding
Video: Represents the raw video to encode
Format: The format to encode the video into
Job: The encoding process itself
Encoded Video: This is the result of the job: the encoded video
Account: Your basic account information

Pings

Another fundamental concept is the Ping, also known as callback which makes the whole process totally async for the developers.

You never need to pull our servers every time you want to know if an encode is done or if a video has been transferred. We actually notify you when those actions are done with a POST HTTP request.

You can see the POST parameters we send to you for the different pings on this page.

Error Codes

100 : Unknown error
101 : Unsupported audio codec
102 : Unsupported video codec
103 : This video cannot be encoded in this format
104 : Wrong settings for audio
105 : Wrong settings for video
106 : Cannot retrieve info from this video
107 : Not a video file
108 : Video too long
109 : Unsupported video container
110 : The audio can’t be resampled
201 : 404 Not Found
202 : Bad address
300 : No more credit available
301 : Not enough credits

Tutorials

Client Libraries

Ruby: http://github.com/particles/heywatch-ruby
Python: http://github.com/particles/heywatch-python
PHP: http://github.com/particles/heywatch-php (by madewithlove)
.NET: http://github.com/particles/heywatch-dotnet