Documentation technique

Accueil / Documentation technique / Flux v2 / API métadonnées / Exploiter la métadonnée Cinéma

Exploiter la métadonnée Cinéma

La métadonnée Cinéma permet d’obtenir et d’afficher les séances d’un cinéma au travers d’une API et/ou d’un widget

Les métadonnées Cinéma sont alimentées au travers de la plate-forme SitraCinema. Veuillez-vous assurer que le cinéma concerné soit effectivement enregistré au sein de cette plate-forme pour que vous puissiez bénéficier de cette fonctionnalité : http://aide.apidae-tourisme.com/enregistrer-un-cinema-sur-la-plateforme-sitra-cinema/

Trouver et exploiter la métadonnées cinema sur une fiche

Sur un objet touristique au format v2, le champ metadonnees liste l’ensemble des métadonnées disponible sur l’objet.
La métadonnée Cinéma correspond à la métadonnée dont le noeud a pour identifiant (« noeudId ») cinema :

"metadonnees" : [{ 
    "noeudId" : "cinema",
    "contenus" : [{ 
        "cible" : "general",
        "metadonnee" : {
            "idSitraCinema" : 91,
            "dateDebutProgramme" : "2015-07-25T17:30:00Z",
            "dateFinProgramme" : "2015-08-22T21:00:00Z" 
        }
     }]
}]
  • idSitraCinema : identifiant du cinéma au sein de la base Allociné
  • dateDebutProgramme : Date de début de la période pour laquelle des séances sont disponibles
  • dateFinProgramme : Date de fin de la période sur laquelle des séances sont disponibles

Les dates de début et fin de programme définissent une plage d’activité du cinéma en dehors de laquelle il n’existera pas de données à afficher. Ainsi, en dehors de cette plage, vous pourrez décider de ne pas afficher le widget au lieu d’afficher un widget « vide ». De même pour l’API, cela vous évitera d’interroger l’API en sachant qu’aucune donnée ne sera renvoyée.

Widget de consultation des séances

La plate-forme SitraCinema fournit un widget qui peut être directement exploité dans vos créations. Ce widget consomme directement les informations présentes dans la métadonnée cinema

Exemple de widget de consultation des séances :

<iframe src="http://cinema.sitra-tourisme.com/widget/91?bg_color=%23333333&cols=3&font_color=%23ffffff&font_family=opensans" width="100%" height="470px" seamless="seamless"></iframe>

Dans l’adresse du widget ci-dessus, le « 91 » correspond à l’identifiant Allociné présent dans la métadonnée.
Les autres critères de l’URL correspondent à des paramètres d’affichage du widget (couleur du fond, couleur de la police …)

API de récupération des séances

La plate-forme SitraCinema met également une API permettant de récupérer la liste des programmes d’un cinéma. La documentation de cette API est disponible ici.