Télécharger la description au format OpenApi YAML (Swagger)

API Mir@bel

Web-service REST pour interroger Mir@bel
Version 1.0.0

Données sous Licence Ouverte, compatible ODC-BY et CC-BY 2.0. Réutilisation possible des données à condition d'en mentionner l'origine.

Licence des données

Licence ouverte : https://www.etalab.gouv.fr/licence-ouverte-open-licence

Format des réponses

Les réponses de l'API sont au format JSON. Le format XML pourrait être ajouté, à la demande.

Liste des chemins

Tous les chemins doivent être préfixés par /api.

Détail des actions

/acces/changes

GET /acces/changes

Titre
Liste des modifications d'accès sur les revues possédées
Description

Liste les ajouts, modifications et suppressions concernant les accès des revues possédées par le partenaire.

URL
GET /api/acces/changes
Paramètres
Nom Description Lieu Requis ? Type, format
partenaireClé privée du partenairequeryOuistring
depuistimestamp à partir duquel lister les changementsqueryOuiinteger
Réponses
Code HTTP Description Schema
200Objet décrivant les ajouts, modifications, suppressionsAccesChanges

/acces/possessions

GET /acces/possessions

Titre
Liste des accès sur les revues possédées
Description

Liste de tous les accès sur les revues possédées par le partenaire.

URL
GET /api/acces/possessions
Paramètres
Nom Description Lieu Requis ? Type, format
partenaireClé privée du partenairequeryOuistring
Réponses
Code HTTP Description Schema
200liste d'accès[ → Acces ]

/acces/revue

GET /acces/revue

Titre
Liste des accès sur une revue
Description

Liste tous les accès sur une revue (qui peut regrouper plusieurs titres si l'historique de la revue est complexe). La revue est identifiée par son ID dans Mir@bel, ou un ISSN, un numéro OCLC de Worldcat, etc. Au moins un critère est nécessaire. Par exemple, /acces/revue?issn=1169-1018 montrera les accès en ligne pour la revue "Population (english edition)" dont l'ancien titre a cet ISSN.

URL
GET /api/acces/revue
Paramètres
Nom Description Lieu Requis ? Type, format
revueidIdentifiant numérique de la revue dans Mir@bel.queryNoninteger
issnNuméro ISSN (ou ISSN-e) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant PPN de SUDOC.queryNonstring
Réponses
Code HTTP Description Schema
200liste d'accès[ → Acces ]
defaultErreurErreur

/acces/titre

GET /acces/titre

Titre
Liste des accès sur un titre
Description

Liste tous les accès sur un titre de revue (qui peut différer de la revue s'il y a un historique de titres). Le titre est identifié par son ID dans Mir@bel, ou un ISSN, un numéro OCLC de Worldcat, etc. Au moins un critère est nécessaire. Par exemple, /acces/titre?issn=1169-1018 montrera les accès en ligne pour le titre "Population (english selection)" qui a cet ISSN.

URL
GET /api/acces/titre
Paramètres
Nom Description Lieu Requis ? Type, format
titreidIdentifiant numérique du titre dans Mir@bel.queryNoninteger
issnNuméro ISSN (ou ISSN-e) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant PPN de SUDOC.queryNonstring
Réponses
Code HTTP Description Schema
200liste d'accès[ → Acces ]
defaultErreurErreur

/revues

GET /revues

Titre
Liste des revues possédées
Description

Liste des revues possédées par un partenaire de Mir@bel, et décrites par leur dernier titre. L'accès est restreint aux partenaires de Mir@bel.

URL
GET /api/revues
Paramètres
Nom Description Lieu Requis ? Type, format
partenaireClé privée du partenairequeryOuistring
ressourceidIdentifiant numérique d'une ressource de Mir@bel (par ex. 3 pour Cairn.info)queryNoninteger
possessionN'afficher que les revues possédées par ce partenaire.queryNonboolean
Réponses
Code HTTP Description Schema
200liste de titres[ → Titre ]
defaultErreurErreur

/revues/detail

GET /revues/detail

Titre
Détail d'une revue
Description

Les infos que Mir@bel fournit sur une revue. Donner au moins un paramètre dans la requête pour sélectionner la revue. Par exemple, /revues/details?issn=0764-7565 montrera le titre actif de cette revue, qui n'a plus l'ISSN recherché.

URL
GET /api/revues/detail
Paramètres
Nom Description Lieu Requis ? Type, format
titreidIdentifiant numérique du titre.queryNoninteger
revueidIdentifiant numérique de la revue.queryNoninteger
issnNuméro ISSN (ou ISSN-e ou ISSN-l) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant PPN de SUDOC.queryNonstring
titreTitre.queryNonstring
sigleSigle.queryNonstring
Réponses
Code HTTP Description Schema
200Détail d'un titre (le dernier de la revue){ → Titre }
defaultErreurErreur

/titres/detail

GET /titres/detail

Titre
Détail d'un titre
Description

Les infos que Mir@bel fournit sur un titre. Donner au moins un paramètre dans la requête pour sélectionner le titre. Par exemple, /titres/details?issn=1660-7880 pour trouver le titre qui a l'ISSN 1660-7880.

URL
GET /api/titres/detail
Paramètres
Nom Description Lieu Requis ? Type, format
titreidIdentifiant numérique du titre.queryNoninteger
revueidIdentifiant numérique de la revue.queryNoninteger
issnNuméro ISSN (ou ISSN-e ou ISSN-l) de la forme XXXX-XXXXqueryNonstring
worldcatIdentifiant numérique de Worldcat.queryNoninteger
sudocIdentifiant PPN de SUDOC.queryNonstring
titreTitre.queryNonstring
sigleSigle.queryNonstring
Réponses
Code HTTP Description Schema
200Détail d'un titre{ → Titre }
defaultErreurErreur

Modèles de données

Acces

idinteger
Identifiant unique attribué par Mir@bel à cet accès.
contenustring
Intégral, Résumé, Sommaire, Indexation
datedebutstring
Date (YYYY ou YYYY-mm ou YYYY-mm-dd) de début d'accès.
datefinstring
Éventuelle date (YYYY ou YYYY-mm ou YYYY-mm-dd) de fin d'accès.
datebarriereinfostring
Description de la date barrière.
dernumurlstring
URL pointant sur le dernier numéro de la revue.
diffusionstring
Libre, Restreint
identifiantpartenairestring
Si interrogation sur les possessions d'un partenaire, donne l'identifiant de possession.
mailurlstring
URL de la revue par alerte courriel.
nodebutinteger
Null ou numérotation initiale, par exemple 6.
nofininteger
Null ou numérotation finale, par exemple 12.
numerodebutstring
Intitulé du numéro initial, par exemple "Vol. I, no 6".
numerofinstring
Intitulé du numéro final, par exemple "Vol. XXV, no 12 (HS)".
rssurlstring
URL du flux RSS de la revue.
titreidinteger
référence à Titre.id
urlstring
URL de la revue.
voldebutinteger
Null, ou volume initial, par exemple 1.
volfininteger
Null, ou volume final, par exemple 25.

AccesChanges

ajouts[ → Acces ]
modifications[ → Acces ]
suppressions[ integer ]

Titre

idinteger
Identifiant unique attribué par Mir@bel à ce titre.
revueIdinteger
Identifiant unique attribué par Mir@bel à cette revue (historique de titres).
obsoleteParinteger
Éventuel identifiant numérique du titre qui a remplacé celui-ci dans la revue.
titrestring
Titre (sans son éventuel préfixe comme "L'").
prefixestring
Préfixe du titre (par exemple "L'").
dateDebutstring, date
Date de début de ce titre.
dateFinstring, date
Éventellement, date de fin de ce titre.
urlstring
Site web de la revue. URL publique, hors Mir@bel.
url_revue_mirabelstring
Page web de la revue sur le site de Mir@bel.
periodicitestring
Périodicité.
electroniqueboolean
La revue est-elle uniquement numérique, sans édition sur papier.
langues[ string ]
Liste des langues de ce titre, par leurs codes ISO à 3 lettres.
derModifstring, date
Date de la dernière modification dans Mir@bel.

Erreur

codeinteger, int32
Code HTTP de l'erreur
messagestring
Description détaillée du problème
fieldsstring
Éventuels champs créant un trouble dans la requête
details?
Éventuels détails sur l'erreur.