Les APIS, développez vos applications cinéma !

API : Une interface de programmation (Application Programming Interface ou API) permet de définir la manière dont un composant informatique peut communiquer avec un autre. C'est donc une interface de code source fournie par un système informatique ou une bibliothèque logicielle, en vue de répondre à des requêtes pour des services qu'un programme informatique pourrait lui faire. La connaissance des API est indispensable à l'interopérabilité entre les composants logiciels.(Source : Wikipédia)

BDFCI vous permet donc d'utiliser des outils pour intégrer dans votre site, des informations de manière dynamique.

Les outils disponibles sont :

- api de recherche dans la base de donnée BDFCI (films, personnalités ou sociétés)

- api d'affichage d'une fiche simplifiée film, personnalité ou société.

- api d'affichage de votre vidéothèque.

Les outils sont des scripts que vous intégrez à votre (vos) page(s) web. Ces scripts envoyent une demande (une requête) sur la base de données, et en retour, vous aurez des informations contenues dans un fichier de type XML.

Il vous appartiendra alors de traiter le fichier retour et de l'intégrer dans votre portails, vos pages web.

Ces apis sont soumises à une condition pour l'utilisation, celle de s'inscrire pour obtenir une clé qui sera à transmettre avec chaque demande.
Cette clé donne accès à un certain nombre de requête quotidienne.

Ces APIS sont une possibilité d'obtenir des informations connues dans une base de données. Elles n'ont pas la prétention d'être exactes, et certaines erreurs peuvent exister. De plus, si l'usage de ces APIS venait à dégrader la qualité de service globale du portail, ce service APIS serait alors purement et simplement supprimé sans autre information qu'un message sur les forums !
Merci de votre compréhension.

film.php5, paramètres nécessaires :

• Objectif : permet d'obtenir les informations complè d'une fiche film. Le script étant encore en développement, certaines informations sont encore manquantes
• Url : http://apis.bdfci.info/film.php5?key=(API_KEY)&id=(id du film recherché)
• Méthode de demande au serveur : GET.
• key : c'est le clé qui vous permet d'effectuer des requêtes, elle est obligatoire.
• id : id du film recherché, soit obtenu dans l'url de la page web sur BDFCI, soit dans la balise dans la page request.php5.
• Pas de lien de démonstration.

Version 0.3 du 27 avril 2010 :
• Ajout de la balise <apis>.
  Cette balise couvre 2 champs :
  - allow : le nombre de requêtes quotidiennes autorisées.
  - used : le nombre de requêtes effectuées dans la journé.
• Suppression de la possibilité d'accès via le compte "DEMO". La clé API est désormais obligatoire.

Version 0.2 du 27 avril 2010 :
• Ajout de la durée du film.

Version 0.1 du 14 janvier 2010 :
• Mise en place du script.

request.php5, paramètres nécessaires :

• Objectif : rechercher des items dans la base de données de la BDFCI, et retourner une brève description éventuellement illustrée.
• Url : http://apis.bdfci.info/request.php5?key=(API_KEY)&results=5&ask=(mots clés)(&exact=yes)
• Méthode de demande au serveur : GET.
• key : c'est le clé qui vous permet d'effectuer des requêtes, elle est obligatoire. (paramètre obsolète depuis le 29/04/2010))
• results : le nombre de résultats demandés.
• ask : votre demande.
• Nouveautés version 0.4 :
• sort : positionné à NOM ou ANNEE, permet un retour de résultats classé par NOM ou ANNEE. (Pour les personnes, tri par NOM uniquement, ANNEE possible pour les films). Si le paramètre n'est pas précisé, NOM est appliqué par défaut.
• order : positionné à ASC (ascendant, ou croissant)ou DESC (descendant, ou décroissant)., permet un retour de résultats classé par NOM ou ANNEE ascendant ou décroissant. Si le paramètre n'est pas précisé, DESC est appliqué par défaut.
• searchtype : positionné à p pour une recherche sur un nom de personne ou f pour une recherche sur un titre de film. Si le paramètre n'est pas précisé, f est appliqué par défaut.

Version 0.7b :
• En cours de développement (beta)
• paramètre full=y permet d'afficher les genre, origine et flux videos si disponibles
• paramètre format=json (exemple complet ci dessous), xml par défaut.
• paramètre media=(flv,iphone3 ou psp) (flv : flux video en flash video, le plus lourd et la meilleure qualité. iphone3 pour iphone 3 et Android, psp pour iphone4, ipad et psp), flv par défaut. Preview est automatiquement affiché si full=y, et quelque soit la valeur du paramètre media.
• Si vous souhaitez tester cette version, merci de m'en faire la demande via le formulaire de contact (seuls les membres peuvent en faire la demande, merci de votre compréhension)
  Exemple :

  {
      "ask": "apocalypto",
      "ResultatTotal": 1,
      "ResultatsRetournes": 1,
      "PlusDeResultats": "http://www.bdfci.info/?q=a...[URL DE RECHERCHE]...",
      "result": {
          "idfilm": 52984,
          "titre": "Apocalypto",
          "duree": 138,
          "synopsis": "Dans les temps tur...[SYNOPSIS]...",
          "affichette": "http://static.bdfci.com/data/0/0/5/2/9/8/4/tn_[...].jpg",
          "url": "http://www.bdfci.info/film/52984/apocalypto",
          "editeurs": {
              "editeur": {
                  "id": "1536",
                  "nom_societe": "Quinta Communications"
              }
          },
          "listePays": {
              "pays": {
                  "id": "3",
                  "origine": "américain"
              }
          },
          "categories": {
              "categorie": {
                  "id": "9",
                  "genre": "Aventure"
              }
          },
          "videos": [
              {
                  "preview": "http://static.bdfci.com/data/0/0/5/2/9/8/4/[...].jpg",
                  "flv": "http://static.bdfci.com/data/0/0/5/2/9/8/4/[...].flv",
                  "iphone3": "http://static.bdfci.com/data/0/0/5/2/9/8/4/[...].mp4",
                  "psp": "http://static.bdfci.com/data/0/0/5/2/9/8/4/[...].mp4"
              }
          ]
      }
  }

Version 0.6 :
• Version supprimée

Version 0.5 du 20 janvier 2010 :
• SUPPRESSION DU PARAMETRE KEY !.
  En d'autres termes, tout le monde peut effectuer une recherche....
• Ajout de la durée des films dans les résultats retournés. (si connue).
• Ajout de l'éditeur des films dans les résultats retournés. (si connu(s)).
• Les autres paramètres sont décrits dans paramètres nécessaires.
• Lien de démonstration

Version 0.4 du 20 janvier 2010 :
• request.php5 prend de nouveaux paramètres : sort,order et searchtype.
• Si searchtype=p, alors request.php5 retournera les noms de personnes connues dans la base, ainsi que son ou ses métiers dans les balises <metiers><metier>(LE METIER)</metier></metiers>. Le tri pour les personnes est uniquement par nom ()ASC ou DESC).
• Les autres paramètres sont décrits dans paramètres nécessaires.
• Lien de démonstration

Version 0.3 du 14 janvier 2010 :
• request.php5 donne désormais l'id de l'item recherché. (exemple : <idfilm>id du film</idfilm>), suite à demande sur le forum.

Version 0.2 du 30 avril 2009 :
• passage de request.php à request.php5. Php5 est plus rapide.
• Possibilité de passer le paramètre exact=yes.
  Ce paramètre est utile, si le nombre de résultats retournés est trop grand par rapport à une demande dont le terme est trop court. (ex : 117, taken...)
• Lien de démonstration. (NB : Ce lien utilise php5, le paramètre 'exact=yes'.)

Version 0.1 du 12 juillet 2008 :
• Création du script request.php.
• Recherches possibles sur la base des films, limitées à 10 résultats maximum.
• 100 requêtes au serveur maximum par jour.
  Compteurs remis à zéro tous les jours 00h00.
• Méthode de demande au serveur : GET.
• Les erreurs sont toutes traitées, pour vous aider à mettre au point vos pages de demandes au serveur.
• C'est une version BETA, des erreurs peuvent survenir !
• Lien de démonstration. (NB : Ce lien n'est plus actif.)