Wiki

Outils pour utilisateurs

Outils du site


bddxmltvids

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
bddxmltvids [07/04/2014]
gilles74 [Envoie de données]
bddxmltvids [12/04/2014] (Version actuelle)
snouf Déplacé -> [[channelstvdb]]
Ligne 1: Ligne 1:
 ====== Bddxmltvids ====== ====== Bddxmltvids ======
  
-{{tag>​api logos xmltv}} +Déplacé ​-> [[channelstvdb]]
-{{pour doc-fr}} +
- +
- +
-<note warning> +
-En cours de développement actuellement pas disponible publiquement +
- +
-[[http://​mythtv-fr.org/​bugtracker/​index.php?​do=roadmap&​project=8|Roadmap]] +
-</​note>​ +
- +
-Bddxmltvids est une api web permettant +
-  - de trouver d'​après un nom de chaîne ou de l'une de ces variante orthographique l'​xmltvid de votre grabber, le logos, et le nom officiel TODO le multliplex en fonction de la région +
-  - la liste des chaînes pour un bouquet +
- +
- +
-====== Conditions d'​utilisation ====== +
- +
-Cette base est communautaire faite le savoir aux utilisateurs de votre application ! Les logos et noms de chaîne sont des marquées déposées. +
- +
-Les données peuvent être utilisées gratuitement pour toute utilisation non-commerciale. Pour une utilisation commerciale,​ contactez nous. +
- +
-En contribuant à cette base, vous acceptez implicitement que les données soient diffusées de façon gratuite ou payante (les éventuelles bénéfices serviront à payer les frais relatif à l'​hébergement ou seront verser à notre convenance a différent projets autours de la philosophie du libre). +
- +
-Le service n'est pas garanti Nous nous réservons le droit d'​interrompre sans pré-avis. +
- +
- +
-====== Documentation ====== +
- +
-L'​accès à l'API se fait par protocole HTTP, les arguments peuvent être transmis par POST ou GET. +
- +
-Exemple : +
-<code bash> +
-CURL .... +
-</​code>​ +
- +
- +
-====== Accès au données ====== +
- +
-===== Communs ===== +
- +
-Information sur les arguments et réponses pour l'​ensemble des fonction d'​accès au données. +
- +
-//​Arguments//​ +
-  * (''​format''​) : format de la réponse. Une valeur : json, php, txt, html. Json par défaut. +
-  * (''​countrys''​) : Pays au format [[wpfr>​ISO_3166-2]] dans lesquels faire la recherches. Séparateur ","​. "​Tous"​ par défaut. FIXME non utilisé pour l'​instant +
- +
-//​Réponse//​ +
-  * ''​data''​ : les données trouvées (vide si aucune donnée) +
-  * (''​infos''​) : informations diverses sous forme d'une liste. Absent si aucune information. +
-  * (''​warnings''​) : avertissements sous forme d'une liste. Absent si aucune avertissement. +
-  * (''​errors''​) : erreurs sous forme d'une liste. Absent si aucune erreur. +
- +
- +
-===== get_channels ===== +
- +
-Récupère les données d'une chaîne par son id ou son alias. +
- +
-//​Arguments//<​br>​ +
-  * (''​id''​) : identifiant unique de la chaîne. Requis si ''​alias''​ n'est pas indiqué. +
-  * (''​alias''​) : alias (variante orthographique) ou nom de la chaîne. Requis si ''​id''​ n'est pas indiqué. Ignoré si ''​id''​ est indiqué. +
- +
- +
-//​Réponse//​ +
-  * ''​data''​ +
-    * ''​channels''​ +
-      * ''​id''​ : identifiant unique de la chaîne +
-      * ''​name''​ : nom de la chaîne +
-      * ''​country''​ : pays de diffusion +
-      * ''​logo''​ : url vers le logo de la chaine +
- +
- +
-===== search_channel ===== +
- +
-Chercher une chaîne. +
- +
-//​Arguments//<​br>​ +
-  * q : texte à chercher +
- +
- +
-//​Réponse//​ +
-  * ''​data''​ +
-    * ''​channels''​ : identique à get_channels retourne au maximum 20 résultats. +
-====== Envoi de données ====== +
- +
-===== Communs ===== +
- +
-Information sur les arguments et réponses pour l'​ensemble des fonctions d'​envoi de données. +
- +
-//​Arguments//​ +
-  * (''​format''​) : format de la réponse. Une valeur : json, php, txt, html. Json par défaut. +
-  * (''​email''​) : Email de notification. Seule les modérateurs y auront accès. Optionnel. +
- +
-//​Réponse//​ +
-  * ''​data''​ : les données trouvées (vide si aucune donnée) +
-  * (''​infos''​) : informations diverses sous forme d'une liste. Absent si aucune information. +
-  * (''​warnings''​) : avertissements sous forme d'une liste. Absent si aucune avertissement. +
-  * (''​errors''​) : erreurs sous forme d'une liste. Absent si aucune erreur. +
- +
-===== set_channels ===== +
- +
-Ajoute ou met à jour une ou plusieurs chaînes. +
- +
-//​Arguments//​ +
-  * ''​channels''​ : liste des chaines au format json ''​[<​chaîne1>,​ <​chaîne2>,​ ...]''​ chaque chaîne devra contenir au minimum un id. On pourra indiquer un nom, le pays de diffusion, un logo et/ou des alias de nom (variante orthographique). <code json> +
-+
-     "​id":​ "​france4.fr",​  +
-     "​name":​ "​France 4",  +
-     "​country":​ "​fr",​  +
-     "​logo":​ http://​upload.wikimedia.org/​wikipedia/​fr/​thumb/​9/​90/​France4-2011.svg/​200px-France4-2011.svg.png",​  +
-     "​alias":​ ["​f4",​ "​france4"​]}  +
-}</​code>​ +
-    * ''​id''​ sous la forme usuelle <​nom_de_la_chaine>​.<​pays>​ insensible à la case. Seul les caractères alphanumériques les "​_"​ et les "​-"​ sont acceptés. Les espaces et caractères spéciaux ne peuvent être utilisés. +
-    * (''​name''​) : nom de la chaine +
-    * (''​country''​) pays de diffusion au format [[wpfr>​ISO_3166-2]] +
-    * (''​logo''​) : une source libre si possible (wikipedia)) +
-    * (''​alias''​) : insensible à la case, mettre le nom de la chaîne est inutile. +
- +
-//​Réponse//​ +
-    * ''​data''​ +
-    * ''​channels'':​ Liste des chaînes sous la même forme que [[#​get_channel]] qui ont eu au moins une modification. +
-    * ''​alias'':​ liste des alias ''​[<​alias1>,​ < alias2>, ...]''​acceptés. Chaque alias contient l' ''​id''​ de la chaîne et l' ''​alias''​. +
-===== set_grabbers ===== +
- +
-Ajoute ou met à jour un ou plusieurs grabbers. +
- +
-//​Arguments//​ +
-  * ''​grabbers''​ : liste des chaines au format json ''​[<​grabber1>,​ <​grabber2>,​ ...]''​ chaque grabber devra contenir au minimum un id. On pourra indiquer un nom, le pays de diffusion, et/ou l'url vers le site du grabber.<​code json> +
-+
-     "​id":​ "​kazer.org",​  +
-     "​name":​ "​KaZeR",​  +
-     "​country":​ "​fr",​  +
-     "​web":​ "​http://​www.kazer.org",​  +
-}</​code>​ +
-    * ''​id''​ sous la forme usuelle <​nom_du_grabber>​.<​pays>​ insensible à la case. Seul les caractères alphanumérique les "​_"​ et les "​-"​ sont acceptés. Les espaces et caractères spéciaux ne peuvent être utilisés. +
-    * (''​name''​) : nom de la chaîne +
-    * (''​country''​) : pays de diffusion au format [[wpfr>​ISO_3166-2]] +
-    * (''​web''​) : url vers le site web (sous la forme http://​...) +
- +
-//​Réponse//​ +
-  * ''​data''​ +
-    * ''​grabbers''​ : liste des grabbers acceptées par l'api sous la même forme qu'en entrée. +
- +
- +
-===== set_xmltvids ===== +
- +
-Ajoute ou met à jour un ou plusieurs xmltvids. +
- +
-//​Arguments//​ +
-  * ''​xmltvids''​ : liste des entrées xmltvids au format json ''​[<​xmltvid1>,​ < xmltvid2>,​ ...]''​ chaque entrée devra contenir ''​grabber_id'',​ ''​channel_id''​ et ''​xmltvid''<​code json> +
-+
-     "​grabber_id":​ "​kazer.org",​  +
-     "​channel_id":​ "​france2.fr",​  +
-     "​xmltvid":​ "​fra2.kazer.org",​  +
-}</​code>​ +
-    * ''​grabber_id''​ : id du grabber qui doit exister (mais pas obligatoirement avoir été accepté) +
-    * ''​channel_id''​ : id de la chaîne qui doit exister (mais pas obligatoirement avoir été accepté) +
-    * ''​xmltvid''​ : xmltvid +
- +
-//​Réponse//​ +
-  * ''​data''​ +
-    * ''​xmltvids'':​ liste des grabbers acceptées par l'api sous la même forme qu'en entrée.+
bddxmltvids.1396898982.txt.gz · Dernière modification: 07/04/2014 par gilles74