The Search API is easy to use. You will just need to take the base of the URL and adding the desired parameters.
http://www.ultimedia.com/api/search/getvideoinfos
This API returns a list of standardized elements which can be in XML or JSON Format. In order to define the chosen datatype, you just have to put in the URL one of the two following parameters :
If you want to to get a file in XML format, your base URL should look like this :
And If you want to to get a file in JSON format, your base URL should look like this :
The MDTK parameter allows you to identify your site thanks to a unique ID. This ID is visible on Ultimedia.com on the tab Account/My Sites/ List of sites
Then, you will just need to click on the “Edit” button of the site on which you wish to insert your videos. The MDTK of your site is on the top of the edit form and is a 8 digit sequences.
This parameter is mandatory
Example : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/
The Zone Parameter is a number and allows you to define where your video will be integrated on your site. It usually is the unitary integration zone or the WebTV widget.
If you are unsure of which zone number to use, please do not hesitate to ask us.
This parameter is mandatory.
Example : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/
The video_id parameter allows you to search on a precise video.
If you want to search for a few catalogues, you'll just need to separate each catalogues with a comma.
Example : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/video_id/fv5pz0?
The Tagparam parameter is used in order to get the targeting ad and is associated with a company name
If you already have a couple of parameters separated by a "/" it will be better to use “tagparamcoded”.
The owner_id parameter allows you to search videos only on one or a few particular catalogues. The unique id of each or your catalogues is available on the tab “Ayant Droit > Vos Catalogues > List des Catalogues” (Beneficiary > Your Catalogues> List of Catalogues) .
It is possible to search on a couple of catalogues with only just one search by separating each id with a comma.
Example : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/owner_id/s0kuk/
The external_id parameter allows you to search only on one or a few of your catalogues.
Like the previous id, you must use it if you don't know the precise id of the video you wish to see the informations of.
It is possible to search on a couple of catalogues with only just one search by separating each id with a comma.
Once you are done with your search, you will get a list of a few elements linked to each of the videos on the results. Here's the exhaustive list of the elements and their use.
The <videoid> elements let you know the unique id of every video on our plateform. For instance, if a video has a video_id « 5krrkj » and it has a News category, its id will be « 21_5krrkj ».
These elements will be useful if you want to use another Digiteka API.
The element <content_type> informs you on the principal theme of the video.
The element <creation_date> informs you on the upload date of the video on our plateform.
<update_date> informs you on the last upload date of the video on the plateform.
If there was no modification on the video, <creation_date> = <update_date>.
A video may have a later release date than the date it was created if, for example, the journalist chooses not to make the video public until after the if the journalist chooses, for example, to make the video public only after a certain a certain period of time.
The element <captions> tells you if the video has subtitles.
Exemple : <![CDATA[ https://medialb.ultimedia.com/captions/3uks5/fv5pz0-def.vtt ]]>
The element <title> tells you the title of the video. It is on this element of the video that the q search is performed.
The element <authors> tells you the name of the video's author.
The element <tags> informs you on the tags or keywords associated to the video. Furthermore it is on this element that the qtag search is performed.
The element <description> informs you on the video's description. It generally is a small paragraph summarizing the content of the video.
The <image>, <image_high>, <image_wide> elements allow you to retrieve four types of thumbnails for each video, which respectively offer resolutions of 134*100, 480*360 and 858*480 for optimal display depending on the type of use you wish to make. The <image_original> format offers a thumbnail in its original resolution as uploaded to our platform.
The <facebook> element allows you to retrieve a URL to insert in your metadata that will be useful for referencing the video and sharing it on the Facebook social network.
The <length> allows you to retrieve the length of the video.
This length is expressed in seconds.
The <label> element allows you to retrieve the information from the catalogue where the video is from.
The <id_label> element allows you to retrieve the information from the catalogue ID where the video is from. This ID is the one used in the parameter “owner_id” mentioned above.
The <sub_categories> allows you to retrieve the information from the sub thematic in which the video is linked.
Both the <embed> and the <iframe> elements allows you to retrieve the unitary integration code of each videos whether it is in Javascript or in iframe format.
These integration codes take the MDTK and the zone number inserted into the API query.
The <external_id> element informs you on the external ID of the video, it is the original ID as it was originally sent to us by the client
The <csa_rating> element informs you on the CSA rating of the video.
The <id_sibling> element tells you the episode number and the season in the case of a series. It can also be the type and identifier of the work record Webedia in the case of a Webedia trailer.
The <in_stream> informs you if the video can be monetized.
If the value of this field is 1, the video can be monetized, if it is 0, no ad can be broadcasted on the content.
The <credit> element contains two informations : <owner> and <provider>
Those elements informs you on the entities of “owner” and “provider” of the video.
The <local_target> informs you on the possible restrictions of the video's broadcasting territory. The geographical areas where video is allowed are entered in ISO format.
The <release_time> element is the date of the first diffusion of the video. If the video was received from another platform, the <release_time> will correspond to the publication date on the first platform. The format of the date of this element is in the Unix timestamp
The <begin_time> and <end_time> elements correspond are the start and end dates for videos that are embargoed and should only start broadcasting from a certain day and time, and the same for the end of broadcast if applicable.
The <external_link> element tells you about any link that may be associated with the video, such as the URL of the article it is associated with.
The <language_iso> element tells you what the primary language of the video. This element is in ISO format
The <original_language> element tells you the nature of the original language of the video (French Version, Original Version, Subtitle Version)