Utilisation des APIs Apidae cinéma

Suite à la mise à jour d'une application chez AlloCiné, les séances de certains cinémas ne plus actualisées sur Apidae Cinéma.

Un problème de compatibilité entre l'ancienne et la nouvelle version de l'application déployée chez AlloCiné a entrainé une rupture de synchronisation des séances. Pour l'heure, les cinémas utilisant les logiciels de caisse proposés par Monnaie Services ou Ciné Office sont touchés, mais le problème devrait s'étendre à l'ensemble des logiciels de caisse d'ici quelques semaines.

Vu les coûts des API Allociné, le développement est abandonné.

Prérequis

Pour pouvoir utiliser les APIs proposées par la plateforme Apidae Cinéma, les conditions suivantes doivent être vérifiées :

• Le cinéma doit être présent dans la base de données Apidae
• Le cinéma doit avoir été enregistré sur la plateforme Apidae Cinéma (voir la documentation correspondante)
• Les informations sur la programmation du cinéma ont dû être importées depuis l’outil Allociné (voir la documentation correspondante)

Utilisation des APIs

Les APIs de la plateforme Apidae Cinéma renvoient des informations sur la programmation des cinémas enregistrés sur la plateforme. Elles sont utiles lorsque l’affichage des informations cinéma demande un degré de personnalisation trop important pour utiliser les widgets générés par la plateforme.

Les données sont transmises au format JSON, dont le détail des champs est donné ci-dessous.

Les règles d’utilisation standards des APIs s’appliquent, et notamment :

• Favoriser la mise en cache des résultats lorsque cela est possible
• Limiter le nombre d’appels consécutifs au service lorsqu’une stratégie de reprise est implémentée

Pour chacun des services décrits ci-dessous, le chemin d’accès au service fourni est relatif au nom de domaine de la plateforme Apidae Cinéma (cinema.apidae-tourisme.com pour l’environnement de production).

Récupérer le programme d'un cinéma

La récupération du programme d’un cinéma se fait en transmettant une requête HTTP avec les caractéristiques suivantes :

• Chemin d’accès: api/v001/{idApidae}/seances.json où idApidae est l’identifiant Apidae du cinéma
• Méthode : GET
• Paramètres :
  • dateDebut
    • description : date du premier jour du programme
    • format : jj-mm-aaaa
    • requis : non
    • valeur par défaut : date du jour
  • dateFin
    • description : date du dernier jour du programme
    • format : jj-mm-aaaa
    • requis : non
    • valeur par défaut : dernier jour pour lequel des séances sont renseignées pour ce cinéma

Exemple :
http://cinema.apidae-tourisme.com/api/v001/315395/seances.json?dateDebut=01-01-2019&dateFin=31-12-2019

Format de la réponse

La réponse est une structure au format JSON qui comprend les informations sur les films et les séances pour la période demandée. Voici ci-dessous un exemple de réponse dans lequel les différent champs sont annotés :

Exemple de réponse du service seances.json