CasuHAL AtelierAPI : Différence entre versions
| (20 révisions intermédiaires par 3 utilisateurs non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
| + | == Atelier API des journées CasuHAL 2019 == | ||
| + | |||
| + | === Support de la présentation === | ||
| + | [[:File:CasuhalAtelierAPI2019.pdf]] | ||
| + | === Mémos === | ||
| + | |||
| + | Formats de réponse [[:File:afficheformatréponses.pdf]] | ||
| + | |||
| + | Paramètres groupes [[:File:affichegroupes.pdf]] | ||
| + | |||
| + | Métadonnées [[:File:affichemetadonnees.pdf]] | ||
| + | |||
| + | Opérateurs de recherche [[:File:afficheopérateurs.pdf]] | ||
| + | |||
| + | Récapitulatif des paramètres [[:File:afficheparamètres.pdf]] | ||
| + | |||
| + | Paramètres des facettes [[:File:afficheparamètresfacettes.pdf]] | ||
| + | |||
| + | Types de champs [[:File:affichetypeschamps.pdf]] | ||
| + | |||
== Atelier API des journées CasuHAL 2018 == | == Atelier API des journées CasuHAL 2018 == | ||
| − | + | '''A l'occasion des journées CasuHAL 2018 et de l'atelier sur l'utilisation des API de HAL, nous avons proposé de commencer par lister des actions à mener pour favoriser l'utilisation des API par le réseau CasuHAL.''' | |
| + | Ci-dessous la trame de l'atelier | ||
| − | + | === Explication de ce qu'est une API=== | |
| + | Les APIs (Application Programming Interface ou interface de programmation) sont des interfaces qui permettent une communication machine à machine. Cela permet à une source de donnée de s'exposer pour un ré-emploi par un autre système informatique. | ||
-> Ce que ça permet | -> Ce que ça permet | ||
| Ligne 13 : | Ligne 35 : | ||
-> Précisions sur l'API d'import Sword et l'entrepôt OAI | -> Précisions sur l'API d'import Sword et l'entrepôt OAI | ||
| − | == Utiliser l'API d'archives-ouvertes ? démonstrations == | + | === Supports de formation sur l'API HAL === |
| + | https://fr.slideshare.net/OAccsd/les-api-de-hal | ||
| + | https://fr.slideshare.net/OAccsd/usage-des-api-de-hal | ||
| + | https://www.slideshare.net/OAccsd/les-api-de-recherche-de-hal | ||
| + | https://fr.slideshare.net/OAccsd/les-api-de-hal-formation-ccsd-mars-2016 | ||
| + | https://fr.slideshare.net/OAccsd/tei-hal-import-sword | ||
| + | |||
| + | === Utiliser l'API d'archives-ouvertes ? démonstrations === | ||
-> Requête -> Que faire du fichier retourné ? | -> Requête -> Que faire du fichier retourné ? | ||
| Ligne 25 : | Ligne 54 : | ||
-> Autre ? (question à la salle ?) | -> Autre ? (question à la salle ?) | ||
| − | == Réaliser des requêtes d'interrogation de l'API == | + | === Réaliser des requêtes d'interrogation de l'API === |
| − | -> | + | -> Diaporama de présentation de la syntaxe des requêtes : [[:File:2018-06-01_CASUHAL_Utilisation des API.pdf]] |
| − | -> | + | -> Scan du contenu de la documentation [[Notes Hélène]] |
| − | == Echange avec la salle et/ou démonstrations de requêtes == | + | === Echange avec la salle et/ou démonstrations de requêtes === |
=== Développer un réseau d’entraide autour des API de HAL : on objectif pour CasuHal ? === | === Développer un réseau d’entraide autour des API de HAL : on objectif pour CasuHal ? === | ||
| Ligne 44 : | Ligne 73 : | ||
'''1 / La question d'une liste d'auteurs affiliés à un établissement (CF question précise posée sur la liste dans le cadre de la prépa de l'atelier)''' | '''1 / La question d'une liste d'auteurs affiliés à un établissement (CF question précise posée sur la liste dans le cadre de la prépa de l'atelier)''' | ||
| − | |||
| − | |||
Essai 1 -> https://api.archives-ouvertes.fr/ref/author/?q=structureId_i:81173&fl=docid,label_s,idHal_i,idHal_s,*_id&rows=10000&wt=xml | Essai 1 -> https://api.archives-ouvertes.fr/ref/author/?q=structureId_i:81173&fl=docid,label_s,idHal_i,idHal_s,*_id&rows=10000&wt=xml | ||
| − | Référentiel auteur | + | Référentiel auteur |
Essai 2 -> https://api.archives-ouvertes.fr/search/uvsq/?q=*:*&facet=true&facet.field=structHasAuthIdHal_fs&facet.mincount=0&facet.prefix=81173_&rows=0&wt=xml&facet.limit=10000 | Essai 2 -> https://api.archives-ouvertes.fr/search/uvsq/?q=*:*&facet=true&facet.field=structHasAuthIdHal_fs&facet.mincount=0&facet.prefix=81173_&rows=0&wt=xml&facet.limit=10000 | ||
| − | + | Les auteurs ne sont pas affiliés (dans auréhal) comme on pourrait le penser, ce sont dans les notices documents que les affiliations sont appliquées = Donc on cherche dans l'api de recherche de documents et on extrait les affiliations par ce biais là. | |
| − | + | ||
| + | Comment obtenir en plus dans cette liste les identifiants accrochés aux auteurs (orcid, idref and cie) = Re requêter 1 à 1 les auteur ?... | ||
Version actuelle datée du 25 juin 2019 à 16:25
Sommaire
- 1 Atelier API des journées CasuHAL 2019
- 2 Atelier API des journées CasuHAL 2018
- 2.1 Explication de ce qu'est une API
- 2.2 Supports de formation sur l'API HAL
- 2.3 Utiliser l'API d'archives-ouvertes ? démonstrations
- 2.4 Réaliser des requêtes d'interrogation de l'API
- 2.5 Echange avec la salle et/ou démonstrations de requêtes
- 2.6 Développer un réseau d’entraide autour des API de HAL : on objectif pour CasuHal ?
- 2.7 Je n'ai pas d'idées : quelles requêtes peuvent être intéressantes pour moi ?
Atelier API des journées CasuHAL 2019
Support de la présentation
File:CasuhalAtelierAPI2019.pdf
Mémos
Formats de réponse File:afficheformatréponses.pdf
Paramètres groupes File:affichegroupes.pdf
Métadonnées File:affichemetadonnees.pdf
Opérateurs de recherche File:afficheopérateurs.pdf
Récapitulatif des paramètres File:afficheparamètres.pdf
Paramètres des facettes File:afficheparamètresfacettes.pdf
Types de champs File:affichetypeschamps.pdf
Atelier API des journées CasuHAL 2018
A l'occasion des journées CasuHAL 2018 et de l'atelier sur l'utilisation des API de HAL, nous avons proposé de commencer par lister des actions à mener pour favoriser l'utilisation des API par le réseau CasuHAL. Ci-dessous la trame de l'atelier
Explication de ce qu'est une API
Les APIs (Application Programming Interface ou interface de programmation) sont des interfaces qui permettent une communication machine à machine. Cela permet à une source de donnée de s'exposer pour un ré-emploi par un autre système informatique.
-> Ce que ça permet
-> Comment ça le permet
-> Présentation des API Recherche et Référentiels de HAL
-> Précisions sur l'API d'import Sword et l'entrepôt OAI
Supports de formation sur l'API HAL
https://fr.slideshare.net/OAccsd/les-api-de-hal https://fr.slideshare.net/OAccsd/usage-des-api-de-hal https://www.slideshare.net/OAccsd/les-api-de-recherche-de-hal https://fr.slideshare.net/OAccsd/les-api-de-hal-formation-ccsd-mars-2016 https://fr.slideshare.net/OAccsd/tei-hal-import-sword
Utiliser l'API d'archives-ouvertes ? démonstrations
-> Requête -> Que faire du fichier retourné ?
-> Affichage "simple" dans un tableur : démonstration d'un export csv et affichage simple dans libreoffice
-> Utilisation de logiciels de traitement de données (pour enrichissement et/ou traitement et/ou nettoyage) : Démonstration avec OpenRefine d'un import de données récupérées, découpage du contenu d'une colonne etc.
-> Affichage dans un site web : démonstration d'un affichage site web avec une requête dans l'API
-> Autre ? (question à la salle ?)
Réaliser des requêtes d'interrogation de l'API
-> Diaporama de présentation de la syntaxe des requêtes : File:2018-06-01_CASUHAL_Utilisation des API.pdf
-> Scan du contenu de la documentation Notes Hélène
Echange avec la salle et/ou démonstrations de requêtes
Développer un réseau d’entraide autour des API de HAL : on objectif pour CasuHal ?
Pistes / propositions :
- Utiliser la liste hal.tech pour les questions concernant l’interrogation de l’API
- Reporter sur le wiki les « réponses »
- Compléter la documentation des requêtes déjà présentes sur le wiki
- Constituer un inventaire des requêtes fréquemment demandées
- Autre ?
Je n'ai pas d'idées : quelles requêtes peuvent être intéressantes pour moi ?
1 / La question d'une liste d'auteurs affiliés à un établissement (CF question précise posée sur la liste dans le cadre de la prépa de l'atelier)
Essai 1 -> https://api.archives-ouvertes.fr/ref/author/?q=structureId_i:81173&fl=docid,label_s,idHal_i,idHal_s,*_id&rows=10000&wt=xml Référentiel auteur
Les auteurs ne sont pas affiliés (dans auréhal) comme on pourrait le penser, ce sont dans les notices documents que les affiliations sont appliquées = Donc on cherche dans l'api de recherche de documents et on extrait les affiliations par ce biais là.
Comment obtenir en plus dans cette liste les identifiants accrochés aux auteurs (orcid, idref and cie) = Re requêter 1 à 1 les auteur ?...
2 / les affiliations : afficher ttes les structures affiliées à un auteur (https://api.archives-ouvertes.fr/docs/ref/resource/authorstructure)
https://api.archives-ouvertes.fr/search/authorstructure/?firstName_t=prenom&lastName_t=nom&i&wt=xml
3 / retrouver des doublons potentiels de publication pour une collection donnée pour une année de production donnée
4 / Liste des structures rattachées à une structure de + haut niveau.
https://api.archives-ouvertes.fr/ref/structure/?wt=xml&q=parentDocid_i:300297&fl=* ou https://api.archives-ouvertes.fr/ref/structure/?wt=csv&q=parentDocid_i:300297&fl=*
On a 165 résultats (Attention la conf par défaut limite à 30)
