Notre API de recherche est disponible en accédant facilement à une URL de base qui est la suivante et à laquelle il faudra rajouter quelques éléments pour une requête complète :
http://www.ultimedia.com/api/search/getvideoinfos
Notre API vous retourne une liste d’éléments standardisés qui peut être au choix au format XML ou au format JSON. Afin de définir le « datatype » désiré, il suffit d’insérer dans l’URL l’un des deux paramètres suivants :
Si vous souhaitez obtenir un fichier au format XML, votre URL de base devra donc ressembler à :
Le paramètre « mdtk » vous permet de définir l’identifiant unique de votre site. Ce dernier est visible sur la plateforme Ultimedia dans l’onglet Comptes / Mes sites / Liste des sites.
Il vous suffit alors de cliquer sur le bouton « Editer » correspondant au site sur lequel vous souhaitez intégrer les vidéos, le MDTK de votre site est présent en haut de la page de ce formulaire d’édition et se présente sous la forme d’une suite de 8 chiffres.
Ce paramètre doit être obligatoirement renseigné.
Exemple : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/
Le paramètre « zone » se présente sous la forme d’un nombre et permet de définir sur quelle zone de votre site la vidéo va être intégrée. Il s’agit généralement de la zone d’intégration unitaire ou du widget WebTV.
Si vous avez un doute quant au numéro de zone à utiliser, n’hésitez pas à nous en faire la demande. Ce paramètre doit être obligatoirement renseigné.
Exemple : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/
Le paramètre « video_id » permet d'effectuer une recherche sur une vidéo en particulier en renseignant son ID Digiteka
Exemple : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/videoid/fv5pz0
Le paramètre « tagparam » pour récupérer le ciblage publicitaire donner on associe ce paramètre le nom d'une compagne.
Il est à noter que lorsque le paramètre contient plusieurs conditions séparer par plusieurs ‘/’ il sera préférable d'utiliser « tagparamdecoded ».
Le paramètre « owner_id » permet de n’effectuer une recherche que sur les vidéos d’un ou de plusieurs de vos catalogues. L’identifiant unique de chacun de vos catalogues est disponible depuis l’onglet Ayant Droit / Vos Catalogues / Liste des Catalogues.
Si vous souhaitez effectuer une recherche sur de multiples catalogues, il suffit de séparer chaque identifiant par une virgule.
Exemple : https://www.ultimedia.com/api/search/getvideoinfos/mdtk/01515498/zone/43/owner_id/s0kuk/
Le paramètre « external_id » permet de n’effectuer une recherche que sur les vidéos d’un ou de plusieurs de vos catalogues.
Il est à noter, comme le paramètre précédent « owner_id » vous l'aurez à l'utiliser si vous ne connaissez pas l'ID précis de votre vidéo à importer.
Si vous souhaitez effectuer une recherche sur de multiples catalogues, il suffit de séparer chaque identifiant par une virgule.
Une fois l’API requêtée, vous obtiendrez une liste de divers éléments liés à chaque vidéo apparaissant dans les résultats. Voici donc le détail de ces éléments ainsi que leur utilité.
| Element | Utilité |
|---|---|
<video_id> |
Vous informent sur l’id unique de chaque vidéo sur notre plateforme. L’item Ces éléments ne vous seront généralement pas utiles mais peuvent vous servir dans le cas de l’utilisation d’une autre API Digiteka. |
<content_type> |
Vous renseigne sur la thématique principale de la vidéo. |
<creation_date> |
Vous informe sur la date d’arrivée de la vidéo sur notre plateforme.
|
<publication_date> |
Correspond à la date de disponibilité de la vidéo sur notre plateforme Une vidéo peut voir sa date de mise à disposition retardée par rapport à sa date de création si le journaliste choisit par exemple de ne rendre sa vidéo publique qu’après un certain temps. |
<captions> |
Vous renseigne si la vidéo possède un sous-titrage. Exemple : |
<title> |
Vous informe sur le titre de la vidéo. C’est par ailleurs sur cet élément de la vidéo que la recherche « q » s’effectue. |
<authors> |
Vous informe sur le nom de l’auteur de la vidéo |
<tags> |
Vous informe sur les tags ou mots-clefs associés à cette vidéo. C’est par ailleurs sur cet élément de la vidéo que la recherche « qtag » s’effectue. |
<description> |
Vous informe sur la description de la vidéo. Il s’agit généralement d’un court paragraphe résumant le contenu de la vidéo. |
<image> |
Vous permet de recupérer une vignette de resolution 134*200 |
<image_high> |
Vous permet de récupérer une vignette de résolution 480*360 |
<image_large> |
Vous permet de récupérer une vignette de résolution 858*480 |
<image_original> |
Vous permet de récupérer une vignette dans la résolution originale telle qu'uploadée sur la plateforme |
<facebook> |
Vous permet de récupérer une URL à insérer dans vos métadonnées et qui vous sera utile pour le référencement de la vidéo ainsi que son partage sur le réseau social Facebook. |
<lengthvideo> |
Vous permet de récupérer la durée de la vidéo. Cette durée est exprimée en secondes. |
<label> |
Vous permet de récupérer l’information du catalogue duquel est issu la vidéo. |
<id_label> |
Vous permet de récupérer l’information de l’ID du catalogue duquel est issu la vidéo. C’est cet ID qui peut être utilisé dans le paramètre owner_id mentionné précédemment. |
<sub_categories> |
Vous permet de récupérer l’information de la sous-thématique à laquelle est rattachée la vidéo. |
<embed> |
Vous permet de récupérer les codes d'intégration de chaque vidéo au format Javascript. Ces codes d’intégration reprennent le MDTK et le numéro de zone insérés en paramètres de la requête API. |
<iframe> |
Vous permet de récupérer les codes d'intégration de chaque vidéo au format iframe. Ces codes d’intégration reprennent le MDTK et le numéro de zone insérés en paramètres de la requête API. |
<external_id> |
Vous renseigne sur l’ID externe de la vidéo, il s’agit de l’ID original de la vidéo tel qu’il nous a été envoyé par le client. |
<csa_rating> |
Vous renseigne sur le niveau de signalétique CSA de la vidéo. |
<id_sibling> |
Vous renseigne sur le numéro de l'épisode et la saison dans le cas d'une série. Il peut également s’agir du type et de l’identifiant de la fiche œuvre Webedia dans le cas d'une bande-annonce Webedia. |
<in_stream> |
Vous renseigne sur la possibilité de monétisation de la vidéo. Si le champ est à 1, la vidéo est monétisable, s’il est à 0, aucune pub ne peut diffuser sur ce contenu. |
<credits> |
Contient deux informations : <owner> et <provider>.Ces éléments vous renseignent sur les entités de « propriétaire » et « fournisseur » de la vidéo. |
<local_target> |
Vous renseigne sur les éventuelles restrictions de territoires de diffusion de la vidéo. Les zones géographiques où la vidéo est autorisée sont renseignées au format ISO. |
<release_time> |
Correspond à la date de première diffusion de la vidéo. Dans le cas des vidéos que nous recevons depuis une autre plateforme, il s’agit de la date de publication de la vidéo sur cette première plateforme. La date est ici au format Unix timestamp. Les éléments |
<external_link> |
Vous renseigne sur l’éventuel lien qui peut être associé à la vidéo, par exemple l’URL de l’article auquel elle est associée. |
<begintime>et <end_time> |
Correspondent aux dates de début et de fin de diffusion pour les vidéos qui subissent un embargo et dont la diffusion ne doit commencer à diffuser qu’à partir d’un certain jour et d’une certaine heure et de même pour la fin de diffusion le cas échéant. |
<language_iso> |
Vous renseigne sur la nature de la langue principale de la vidéo au format ISO |
<original_language> |
Vous renseigne sur la nature de la langue originale de la vidéo (VF, VO, VOST) |