Skip to content

API COUVERTURE SERVICE

spillorg edited this page Nov 10, 2016 · 24 revisions

API COUVERTURE SERVICE

Contexte

L'API couverture service permet d'afficher la première et la quatrième page de couverture des documents édités ou diffusés en France, et reçus par la BnF au titre du Dépôt Légal.

Documentation

L'API couverture service est une API "URL" en mode GET qui donne l'image (de la première ou de la quatrième de couverture) du document au format jpeg ou png.

URL : http://catalogue.bnf.fr/couverture

Paramètres de l'URL :

Paramètre Obligatoire Format Valeur Libellé
appName Oui String NE L'application appelante. La valeur à utiliser est "NE"
idArk Oui String - L' identifiant ARK du document (requis si idImage non utilisé)
couverture Oui Numérique 1 ou 4 1 pour la première de couverture , 4 pour la quatrième de couverture
largeur Non Numérique - La largeur de l'image
hauteur Non Numérique - La hauteur de l'image
idImage Oui Numérique - L'identifiant de l'image du document (requis si idArk non utilisé)

Exemples :

Récupération de la première page de couverture avec idArk:
http://catalogue.bnf.fr/couverture?&appName=NE&idArk=ark:/12148/cb450989938&couverture=1

Récupération de la quatrième page de couverture avec idArk:
http://catalogue.bnf.fr/couverture?&appName=NE&idArk=ark:/12148/cb450989938&couverture=4

Récupération de la première page de couverture en mode vignette avec idArk:
http://catalogue.bnf.fr/couverture?&appName=NE&idArk=ark:/12148/cb450989938&couverture=1&largeur=100&hauteur=250

Récupération de la première page de couverture avec idImage:
http://catalogue.bnf.fr/couverture?&appName=NE&idImage=210832&couverture=1

Récupération de la quatrième page de couverture avec idImage:
http://catalogue.bnf.fr/couverture?&appName=NE&idImage=210833&couverture=4

Récupération de la première page de couverture en mode vignette avec idImage:
http://catalogue.bnf.fr/couverture?&appName=NE&idImage=210832&couverture=1&largeur=100&hauteur=250

Difficultés

L' API est une API "URL" en mode GET. Cette API est très simple à utiliser.

Les documents qui possèdent des pages de couverture sont visibles dans http://nouveautes-editeurs.bnf.fr/. http://nouveautes-editeurs.bnf.fr/ offre l'accès aux documents qui sont parus il y a moins de 6 mois ou qui vont paraître dans les 6 prochains mois.

Clients de l'API à la BnF

http://bibliographienationale.bnf.fr/ (utilisation avec idArk).
http://catalogue.bnf.fr/ (utilisation avec idImage).

950 .. $a 210832 $b C1
950 .. $a 210833 $b C4 
En fin de notice, 2 zones "950" sont présentes. Une pour la première page de couverture , une pour la quatrième   page de couverture. Le $a représente l'idImage, le $b le numéro de la page de couverture sans le "C".

Le catalogue a appelé l'API couverture service avec les 2 URL suivantes:<BR>
http://catalogue.bnf.fr/couverture?&appName=NE&idImage=210832&couverture=1 :+1:<BR>
http://catalogue.bnf.fr/couverture?&appName=NE&idImage=210833&couverture=4 :+1:<BR>

Clone this wiki locally