Principe

Une API (ou Application Programming Interface) est une interface, fournie par un programme informatique, qui lui permet d'interagir avec un autre programme. L'API proposée par Zotero1 permet de construire une URL contenant des paramètres (paramètres de requêtes ou de format) et de générer un fichier HTML ou ATOM correspondant à cette requête. Cette URL est intégrée dans le site eZpublish au moyen d’une balise <iframe>2.

L’URL de base de l’API Zotero est https://api.zotero.org. 

Le point d’interrogation « ? » permet d’ajouter des paramètres de la requête à l’URL de base, chaque paramètre étant combiné au précédant par le signe « & ». Les requêtes utilisées concernent les utilisateurs (/users/<userID>) ou les groupes (/groups/<groupID>).

Exemple d'URL utilisant l'API Zotero : https://api.zotero.org/groups/54777/collections/4BJ8PWW8/items?format=bib&style=nature

Cette URL affichera dans un navigateur les références (items) de la collection (collectionsAquaculture & environnement (4BJ8PWW8) du groupe (groups) "INRA - Gaz et Aquaculture" (54777) au format XHTML (format=bib) et selon le style bibliographique de la revue Nature (style=nature).

Intégrée dans eZpublish cette requête génèrera une liste comme celle-ci :

zotero-3.JPG

Les références ne sont pas "physiquement" intégrées au site eZpublish, il n'y a pas d'objet créé mais simplement une "vue" des références Zotero à travers eZpublish.

Marche à suivre

Aller sur la bibliothèque Zotero concernée puis sélectionner le tag ou la collection (répertoire).
Exemple : collection "Aquaculture & environnement" de la bibliothèque du groupe "INRA -Gaz et aquaculture"

zotero-4.JPG

Afficher l’URL du flux correspondant. Pour cela, faire un clic droit sur « Subscribe to this feed » puis copier l’adresse du lien.

zotero-1.JPG

URL obtenue pour l'exemple précédant : https://api.zotero.org/groups/54777/items/top?start=0&limit=25
Cette URL va servir de point de départ pour élaborer une requête permettant d’interroger Zotero depuis le site eZpublish en ajoutant des paramètres adéquats.

Pour obtenir une liste au format HTML affichée selon un style bibliographique défini, on utilisera les paramètres suivants :

  • format=bib
    Attention ! le nombre de publications que l'on peut afficher dans ce format est limitée à 150. Si l'on veut en afficher plus, il faudra donc utiliser plusieurs requêtes successives et organiser ses collections Zotero en fonction
  • style=nom_du_style
    Seuls les http://www.zotero.org/styles sont utilisables. Le nom du style à indiquer est celui qui est affiché dans la dernière partie de l'URL lorsqu'on survole le lien vers le style avec la souris.
    Exemple : "ajp-cell-physiology" pour le style correspondant à la revue American Journal of Physiology - Cell Physiology (http://www.zotero.org/styles/ajp-cell-physiology).
    Exemple de requête utilisant les paramètres "format" et "style" :
    https://api.zotero.org/groups/54777/collections/4BJ8PWW8/items
    ?format=bib&amp;style=ajp-cell-physiology
  • La balise <iframe> est utilisée ensuite pour insérer l'URL de la requête dans le code source d'une zone texte d'une page eZpublish.
    Exemple : <iframe width="100%" height="600" frameborder="0" src="https://api.zotero.org/groups/54777/collections/4BJ8PWW8/items?format=bib&amp;style=ajp-cell-physiology"></iframe>

Résultat de cette requête précédente affiché sur un site eZpublish (https://www4.nancy.inra.fr/formation_nancy/Sylvie/Zotero-API) :

  • avec le paramètre : style=ajp-cell-physiology
    zotero-5.JPG
  • avec le paramètre : style=nature
    zotero-6.JPG
  1. ^ La documentation de l'API est à l'URL http://www.zotero.org/support/dev/server_api/start
  2. ^ La balise permet d'insérer un document HTML dans une page HTML. Documentation de la balise : http://www.w3.org/TR/html401/present/frames.html#edef-IFRAME
Tags:
Créé par mgibaud le 15/10/13 10:17
   
© INRA Copyright - Directeur de publication : Odile Hologne
XWiki Enterprise 6.4.6 - Mentions Légales