To access all the latest updates, features & functionality we strongly advise that you use API v2

API v1 Has Been Deprecated

To access all the latest updates, features & functionality we strongly advise that you use API v2

Summary

vzaar uses the oEmbed open standard for allowing 3rd parties to integrated with the vzaar. You can use the vzaar video URL to easily obtain the appropriate embed code for that video. To find out more about oEmbed view the specification here: http://oembed.com/

Endpoint

/api/videos/{video}.{format}

Formats

  • XML
  • JSON

Arguments

  • videos is the vzaar video number for that video.

Parameters

  • borderless, boolean - If set to true and the user has sufficient privileges, the size and embeded code returned will be be for a borderless player. Else ignored
  • embed_only, boolean - When returning data, only include the minimum fields and embed code possible. Use this if you want the quickest and smallest return code for embedding in it

HTTP Methods

  • GET

Authentication

Responses

API responses may differ and they are depend on video's state:

Examples:

<?xml version="1.0" encoding="UTF-8"?>
  <vzaar-api>
    <video>
      <id>2762728</id>
      <state>Processing not complete</state>
      <video_status_id>1</video_status_id>
    </video>
  </vzaar-api>

  <?xml version="1.0" encoding="UTF-8"?>
  <oembed>
    <type>video</type>
    <version>1.0</version>
    <width>240</width>
    <height>244</height>
    <html>
      <![CDATA[<iframe allowFullScreen allowTransparency="true" class="vzaar-video-player" frameborder="0" height="244" id="vzvd-2762728" mozallowfullscreen name="vzvd-2762728" src="//view.vzaar.com/2762728/player" title="vzaar video player" type="text/html" webkitAllowFullScreen width="240"></iframe>
]]>
    </html>
    <video_status_id>2</video_status_id>
    <video_status_description>Transcoded</video_status_description>
    <play_count>0</play_count>
    <total_size>0</total_size>
    <title>v1-prod</title>
    <description>xx</description>
    <author_name>cfx</author_name>
    <author_url>http://app.vzaar.com/users/cfx</author_url>
    <author_account>34</author_account>
    <provider_name>vzaar</provider_name>
    <provider_url>http://vzaar.com</provider_url>
    <video_url>https://view.vzaar.com/2762728/video</video_url>
    <thumbnail_url>https://view.vzaar.com/2762728/thumb</thumbnail_url>
    <thumbnail_width>120</thumbnail_width>
    <thumbnail_height>90</thumbnail_height>
    <framegrab_url>https://view.vzaar.com/2762728/image</framegrab_url>
    <framegrab_width>240</framegrab_width>
    <framegrab_height>244</framegrab_height>
    <duration>5.0</duration>
    <renditions>
      <rendition>
        <type>sd</type>
        <status_id>3</status_id>
        <status>finished</status>
      </rendition>
      <rendition>
        <type>hls</type>
        <status_id>2</status_id>
        <status>processing</status>
      </rendition>
    </renditions>
  </oembed>

Description

  • type - This is the oEmbed resource type. For vzaar video assets this will always be video
  • version - This is the oEmbed API version number. vzaar currently uses version 1.0
  • title - This is the video title. It may be null.
  • description - This is the video description. It may be null.
  • author_name - This is the vzaar user name (i.e. their login)
  • author_url - This is a link to the vzaar user summary page
  • author_account - This is a number reperesenting the users vzaar account. If it is a 1 it represents a free account which has some account limitations. Currently all paid accounts have the same privileges. If this changes an API call will be made available to deal with this.
  • provider_name - This will always be vzaar
  • provider_url - This will always be http://vzaar.com
  • thumbnail_url - This will be a URL link that points to the video thumbnail which can be used to display a small image of the start of the video
  • thumbnail_width - The width of the thumbnail in pixels. This is usually 120px
  • thumbnail_height - The height of the thumbnail in pixels. This is usually 90px.
  • framegrab_url - This will be an URL that points to a framegrab of the video. This is the same as the thumbnail normally but a bigger size, and represents the still image on sees before clicking play in the video player.
  • framegrab_width - The width of the framegrab image in pixels. This will be normally be the same size as the video, but not necessarily the same size as the video player which may be larger. The default size is 320px
  • framegrab_height - The height of the framegrab image in pixels. This will be normally be the same size as the video, but not necessarily the same size as the video player which may be larger. The default size is 240px
  • html - This will return the exact HTML you need to use to emebed the video into a webpage. This should work for all standard webpages.The HTML will be encoded as follows JSON- Applicake to provide XML- CDATA Applicake, how do we explain how we format the < and > signs?
  • height - This is the height of the video player in pixels. For standard videos of 240pxs in width this will be 254px as it includes the frame border of the player
  • width - This is the width of the video player in pixels. For standard videos of 320pxs in width this will be 334px as it includes the frame border of the player
  • borderless - When the video player has no border this will be returned as true. In this case the video size and player size are equal.
  • duration - The duration of the video uploaded
  • video_status_id - The current status of the video, as in the table below. A status of 2 represents a normal video that is processed and available to be played
  • video_status_description - A descriptive text representing the video status
  • play_count - This will be the number of times the video has been played
  • total_size - This is a number representing total size of the video file
  • renditions - Name and status of other renditions

Notes

Video Status ids

  1. Processing not complete
  2. Available (processing complete, video ready)
  3. Expired
  4. On Hold (waiting for encoding to be available)
  5. Ecoding Failed
  6. Encoding Unavailable
  7. n/a
  8. Replaced
  9. Deleted
  10. n/a
  11. Initializing
  12. Finalizing

Example

Call: http://vzaar.com/api/videos/17069.xml

Response

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
  <oembed>
  <type>video</type>
  <version>1.0</version>
  <title>All about my Buisness - Video Interview</title>
  <author_name>video_super_star</author_name>
  <author_url>http://vzaar.com/users/video_super_star</author_url>
  <provider_name>vzaar</provider_name>
  <provider_url>http://vzaar.com</provider_url>
  <total_size>3808516</total_size>
  <html><![CDATA[&lt;!-- VZAAR START --&gt;&lt;div class=&quot;vzaar_media_player&quot;&gt;&lt;object id=&quot;video&quot; width=&quot;334&quot; height=&quot;254&quot; type=&quot;application/x-shockwave-flash&quot; data=&quot;http://vzaar.com/videos/19152.swf&quot;&gt;&lt;param name=&quot;movie&quot; value=&quot;http://vzaar.com/videos/19152.swf&quot;&gt;&lt;param name=&quot;allowScriptAccess&quot; value=&quot;always&quot;&gt;&lt;param name=&quot;allowFullScreen&quot; value=&quot;true&quot;&gt;&lt;param name=&quot;movie&quot; value=&quot;http://vzaar.com/videos/19152.swf&quot;&gt;&lt;param name=&quot;wmode&quot; value=&quot;transparent&quot;&gt;&lt;param name=&quot;flashvars&quot; value=&quot;brandText=vzaar - professional video hostng&amp;brandLink=http://vzaar.com&quot;&gt;&lt;embed src=&quot;http://vzaar.com/videos/19152.swf&quot; type=&quot;application/x-shockwave-flash&quot; wmode=&quot;transparent&quot; width=&quot;334&quot; height=&quot;254&quot; allowScriptAccess=&quot;always&quot; allowFullScreen=&quot;true&quot; flashvars=&quot;brandText=vzaar - professional video hostng&amp;brandLink=http://vzaar.com&quot;&gt;&lt;/embed&gt;&lt;video width=&quot;320&quot; height=&quot;240&quot;  poster=&quot;http://vzaar.com/videos/19152.frame&quot;&gt;&lt;/video&gt;&lt;/object&gt;&lt;/div&gt;&lt;!-- VZAAR END --&gt; ]]></html>
  <height>254</height>
  <width>334</width>
  </oembed>

contact us   by phone, mail or twitter...
libraries
ruby java php .net node
affiliates
affiliate program


Powered by Olark