API Documentation

Comparing version 16 and version 15 back

Our API is based on REST principles, so what you just have to do is an HTTP request to the right resource and the right describing method. The URL to request is always the same: http://heywatch.com or https://heywatch.com

To use our API, you must be authenticated via Basic Auth.

**Which method for which action?**

  * GET	   : Get information about a resource
  * POST   : Create a resource
  * PUT	   : Modify a resource
  * DELETE : Delete a resource

Hey!Watch can send you the response in the XML format. To do this, just put ".xml" at the end of the URI like http://heywatch.com/format.xml.

You can also use the header to specify what you want thanks to the header "Accept". For example, for XML format, you have to add the following header to the request: "Accept: application/xml".

h2. Resources


  * [[API Documentation Encoded Video|Encoded video]]
  * [[API Documentation Video|Video]]
  * [[API Documentation Format|Format]]
  * [[API Documentation Job|Job]]
  * [[API Documentation Upload|Upload]]
  * [[API Documentation Discover|Discover]] *DEPRECIATED*
  * [[API Documentation Download|Download]]
  * [[API Documentation Account|Account]]
  * [[API Documentation Ping Examples|Ping examples]]


h2. HTTP Code response


    * 200 : response OK
    * 201 : means that the resource has been created successfully
    * 204 : means that the resource has been updated or deleted successfully (no body response)
    * 400 : your request ended to an error. It will be displayed in the response
    * 404 : the resource you requested is not available
    * 406 : the format you asked is not available (no body response)

Example response 400 in XML: http://heywatch.com/download.xml [POST]


No URL submitted.





h2. 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

h2. Library

  * Ruby: http://heywatch.rubyforge.org

h2. Changelogs

  * *2007-11-21:* Add watermark_image_url and watermark_position. See [[API Documentation Job|Job resource]]
  * *2007-11-16:* Add http_upload_directive. See [[API Documentation Job|Job resource]]
  * *2007-11-11:* Add keep_quality and deinterlace encoding options. See [[API Documentation Job|Job resource]]