Documentation technique

Multimédias

Les ressources multimédias sont importantes pour agrémenter l’offre touristique. Tous les éléments sont disponibles dans les champs illustrations et multimedias.

La structure des multimédias est toujours la même et peut être trouvée dans le schéma JSON. Les différentes valeurs du champ type sont données dans le schéma JSON.

Champs multimedias et illustrations

Les ressources multimédias sont disponibles dans les champs illustrations et multimedias. Le champ illustrations regroupe toutes les ressources susceptibles d’être affichées dans un diaporama. Il peut s’agir de photographies, de visuels d’affiche, de plans (image) pour les hébergements. Ces ressources sont de manière générale affichables dans un navigateur.

L’ordre des illustrations est choisi par l’utilisateur à la saisie et doit de manière générale être reproduit à l’affichage.

Des multimédias de type LOGO, stockés dans le champ multimedias, peuvent être disponibles et peuvent être affichables avec les illustrations. Parlez-en avec votre client.

Disponibilité et récupération des multimédias

Les multimédias sont disponibles par l’url communiquée dans le champ traductionFichiers[].url. Ces fichiers peuvent être hébergés par Apidae ( https://static.apidae-tourisme.com/… ) ou à l’extérieur.
Il est demandé aux développeurs :

  • d’indiquer, via l’utilisation du champ User-Agent, l’origine des requêtes lors de la récupération des multimédias. Exemple de format : {prestataire} – {nom du projet} #{projetId}
  • de mettre en place les méthodes de cache adéquates lors de la récupération des multimédias pour les projets à fort trafic.

Types de multimédia

Le tableau suivant répertorie les différents types de multimédias actuellement supportés par l’application Apidae. 

Cette liste n’est pas figée et est susceptible de s’enrichir de nouveaux types de multimédias.
De manière à assurer l’évolutivité de vos applications, il est conseillé de concevoir votre application de manière à accepter les nouvelles valeurs pour le champ type.

Type Description
IMAGE_PRINCIPALE Images principales
IMAGE Images diverses
DOCUMENT Documents textes
SON Sons
VIDEO Vidéos
PLAN Plans, Tracé GPS, kml/kmz
LOGO Logos
IMAGE_TOURISME_AFFAIRES Images liées au tourisme d’affaire
VISITE_VIRTUELLE Visites virtuelles
BROCHURE_VIRTUELLE Brochures virtuelles
WEBCAM Liens vers les webcam
BON_PLAN Bons plans
IMAGE_HANDICAP Images liées à l’accessibilité pour les personnes à mobilité réduite.
WEBCAM_360 Liens vers les webcam 360°
IMAGE_PRINCIPALE_HIVER Images principales pour les activités d’hiver
IMAGE_HIVER Images diverses liées aux activités d’hiver
CHAINE_YOUTUBE Chaînes YouTube
CHAINE_DAILYMOTION Chaînes Dailymotion
GALERIE_FLICKR Galleries Flickr
APPLICATION_IPHONE Applications pour iPhone
APPLICATION_IPAD Applications pour iPad
APPLICATION_ANDROID Applications pour Android
APPLICATION_ANDROID_TABLETTE Applications pour tablettes Android

Cas particuliers des types WEBCAM et WEBCAM_360

Dans le cas d’un multimédia de type WEBCAM ou WEBCAM_360, le champ observation est utilisé pour stocker un lien vers une miniature de la caméra.
Dans les autres cas, le champ observation n’est pas utilisé.

Cas particulier des images

Quand le type de fichier est compatible avec les images reconnues par la plate-forme, Apidae réalise 3 miniatures de l’image. Les types compatibles sont jpg, gif et png.

Ces miniatures sont fournies dans les champs suivants :

  • traductionFichiers[].urlListe : miniature petite taille destinée à un affichage en liste (taille maximum : 100×100)
  • traductionFichiers[].urlFiche : miniature taille moyenne destinée à un affichage sur une fiche (taille maximum : 210×210)
  • traductionFichiers[].urlDiaporama : miniature grande taille destinée à un affichage plein écran (taille maximum : 1000×600)
  • traductionFichiers[].url : c’est l’image originale introduite à la saisie

Ces miniatures sont celles utilisées sur le site http://base.apidae-tourisme.com

Le ratio de l’image est conservé, et les tailles indiquées sont des tailles maximum ; l’image peut donc présenter une ou deux dimensions inférieures à la taille maximum indiquée.

Ces miniatures sont uniquement disponibles pour les fichiers stockés sur la plate-forme Apidae. Les multimédia hébergés ailleurs ne disposent pas de miniature.

Temps de rétention des fichiers et date limite

Pour les fichiers stockés sur la plate-forme Apidae, les fichiers sont conservés le temps de la durée de vie (saisie sur un objet) + 15 jours (sauf en cas d’utilisation de date limite – voir ci-dessous).

Les utilisateurs, lors de la saisie, peuvent aussi indiquer une date limite. Dans le cas où une date limite est saisie :

  • des tableaux de bord permettent à l’utilisateur de suivre la liste des objets approchant de la date limite ou ayant dépassé la date limite ;
  • lors de l’export ou de la consultation des API, les multimédias ayant dépassé la date limite sont filtrés et ne sont pas disponibles dans les résultats communiqués ;
  • le dépassement de la date limite est considéré comme une modification et l’objet est ré-exporté. Le mécanisme différentiel de l’export vous permet donc de filtrer les multimédias à afficher ;
  • un champ dateLimiteDePublication est présent sur le multimédia. Si vous stockez une ou des copies locales du multimédia, nous vous demandons de cesser toute publication une fois cette date dépassée.