What is IVA’s OData API 2.0?
In short this is the newest version of our OData API for accessing all of IVA’s content. It is targeted for use by anyone not working with one of our preferred data partners. Check out the Data Integration page to see if we are working with your data provider or contact our sales team to find out more about data integration. If your data provider is listed there then follow the instructions specific to that data provider.
IVA’s OData API 2.0 connects you to our huge library of video assets, our massive ever growing metadata collection, and our amassing number of images. Our video assets include: movie trailers, TV series, season and episode trailers, video game trailers, music videos and much, much more! Our data collection is expanding daily and our API is designed to easily allow you to aggregate our data to your application or web site. IVA has partnered with one of the top companies, Microsoft, in cloud based computing (Azure) to run this data service to ensure that it is the most reliable, scalable, and portable system in the industry.
The IVA OData API 2.0 is built using OData (Open Data Protocol) (for powerful queries) and it leverages web technologies such as HTTP, Atom Publishing Protocol (AtomPub) and JSON.For more information on oData please visit their web site http://www.odata.org/.
What is new in OData 2.0
In addition to a big performance increase over the previous version we now return a much smaller JSON response by default. This will cut down on overhead in the request and increase performance for our customers.
New in the Video Assets Entity:
|RequiresIVAPlayer||This property was added to allow programmers to easily identify content that can only be played through IVA’s Cross Platform Player and cannot be used with our Video API. There is no additional charge for this content.|
|AllowAds||This property was added to fulfill a requirement by certain copyright holders that want to disallow ads in front of their content but is rarely used. Default = True|
|CopyrightholderId||This is not a new property to IVA but was not previously a part of the video assets entity. This Id allows developers and IVA identify copyright holders of individual assets.|
|HasContent||This field is new to the video assets entity and denotes that there is content for the asset. (Boolean)|
Changes the Entertainment Programs Entity:
|MusicRiaaID||Removed. There is a new property called SongRiaaID to facilitate this data.|
|MusicCategoryID||Removed. There is a new property called SongCategoryID to facilitate this data.|
|MusicWarningID||Removed. There is a new property called SongWarningID to facilitate this data.|
|MusicAlbumTitle||Removed. There is a new property called SongAlbumTitle to facilitate this data.|
|HasIvaContent||Removed. This information is now handled in VideoAsset entity.|
|YouTubeContent||Removed. To identity content that is YouTube look at the VideoAsset entity where RequiresIVAPlayer is true.|
New Entity Region Restrictions:
RegionRestrictions Entity (OData 2.0)This new entity allows developers to manage content where there are explicit region restrictions attached. This only applies to additional linked content (YouTube) being leveraged by IVA for use inside our Cross Platform Player. Restrictions can be presented in two ways. A published ID can be either Explicitly Allowed for a single country or a group of countries and all others would be not allowed OR a published ID can be Explicitly NOT Allowed for a specific country or group of countries.
|PublishedId||This is the IVA unique identifier for a video asset. The Video Assets entity is linked to the Region Restrictions Entity|
|CountryId||The reference Id for a country in the Country Entity. The Country Entity is linked to the Region Restrictions Entity|
|Allowed||Tells developers if the country is explicitly allowed or not allowed (True or False).|
RESTful – IVA’s OData API 2.0 incorporates Representational State Transfer (REST) architecture.
This makes the system easy to use and easy to understand. Data can be accessed using simple,
intuitive URLs to content. For example: http://api.internetvideoarchive.com/2.0/DataService/
EntertainmentPrograms would return all EntertainmentPrograms.
EntertaInmentPrograms – All of IVA’s content is now integrated into a single collection of
Entertainment Programs that allows users to search across TV, Movies, Music, Games and Other
entertainment content. Users can also specify exact Entertainment Program types if they wish.
TV Data – TV content is now organized and searchable by TV Series, TV Seasons, and TV Episodes with a Series -> Season -> Episode hierarchy.
Unlimited Filtering – All of the IVA collections can be queried using every property in the collection. Filtering operators include equal (Eq), not equal (Ne), greater than (Gt), greater than or equal to (Ge), less than (Lt), less than or equal to (Le), And, Or, and Not. For a complete list of all filtering options visit oDATA query options.
IVA Warning – IVA’s database now includes “red band” content and foreign content that is not suitable for general audiences. These video assets are available in the VideoAssets collection where the IVAWarning property is set to ‘true’. This flags the content so that you can choose whether or not to include it on your site.
Joining Data Server Side – IVA’s OData API 1.0 allows developers to join various associated collections of data together to reduce round trip request. This improves efficiency and performance.
Security Options – In addition to using a DeveloperID Token appended to the URL, developers can now pass the DeveloperID in the request header. IVA also offers Basic Authentication options for subscribers with a CustomerID and password.
Service Limiting – IVA’s OData API 2.0 uses rate limiting by IP address, and DeveloperID. This rate-limiting ensures that access to the service is available.
Data Formats – IVA’s OData API 2.0 are available in ATOM and JSON formats. Default is JSON and is now a cleaner more lightweight version than what was previously returned by our OData 1.0 API.
Compatibility and Accessibility – IVA’s OData API 2.0 was built using open standard OData, so it
is compatible with a host of OData-Ready applications like Excel, Web Browsers, and various Client Libraries.
GetEncodes() Method – This provides a secure way to get hashed URLs to video content for any video resource.
Documentation – As with any other OData service, you can browse the top level endpoint (or any
intermediate resource) to discover the sub-resources available, or you can use the documentation to guide your exploration.