Transcript 5-Formation_WS - CCSd

Utiliser les WebServices
[email protected]
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
Sommaire






Présentation
Les différentes étapes
L’accès aux référentiels
Effectuer / modifier un dépôt
Consulter / Rechercher des dépôts
Exemple
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
Présentation
 Services Web (WS) fondés sur le protocole SOAP
 Méthodes permettant à un système informatique local de
réaliser des opérations telles que celles proposées sur
l’interface de HAL
 consultation des référentiels internes de HAL (métadonnées,
laboratoires, domaines scientifiques, etc.)
 dépôt, modification d’articles scientifiques
 consultation ou recherche d’articles scientifiques déposés sur
HAL
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
3
Les différentes étapes
 Identifier les méthodes à utiliser
(http://www.ccsd.cnrs.fr/support.html#webservices_hal)
 Prendre connaissance des structures de chaque élément
utile
 Pour effectuer /modifier des dépôts :
 Utiliser l’environnement de développement pour tester, le compte
à utiliser est « test_ws » avec le mot de passe « test »
 Se créer un compte sur un portail de HAL
 Demander au ccsd (ccsd‐[email protected]) d’activer ce compte
pour l’utilisation des WS
 Passer du serveur de développement au serveur de production
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
4
Consultation des référentiels
 Consultation des référentiels internes de HAL
(métadonnées, laboratoires, domaines scientifiques, etc.)
accessible via le protocole HTTP à l’URL :
Serveur de production :
http://hal.archives-ouvertes.fr/ws/ref.php
wsdl : http://hal.archives-ouvertes.fr/ws/ref.php?wsdl
Serveur de développement / test :
http://paol.ccsd.cnrs.fr/ws/ref.php
wsdl : http://paol.ccsd.cnrs.fr/ws/ref.php?wsdl
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
5
Consultation des référentiels
•
Les laboratoires
•
•
•
•
•
•
•
•
•
•
addRefLab :
getRefAffi :
getRefAffi_byName :
getRefLab :
getRefLab_byAffi :
getRefLab_byAuthor :
getRefLab_byId :
getRefLab_byName :
getRefLab_byShortName :
getRefLab_search :
•
Les revues
•
•
•
•
•
•
getRefReview :
Récupération des revues
getRefReview_byEditor :
Récupération des revues à partir d'un éditeur
getRefReview_byISSN :
Récupération des revues à partir de l'ISSN
getRefReview_byId :
Récupération des informations sur une revue
getRefReview_byName :
Récupération des revues à partir d'un nom
getRefAudience : Récupération des audiences des journaux
•
Les domaines
•
•
•
getRefSubject :
getRefSubject_byCode :
getRefSubject_byCodeParent :
Ajout d'un laboratoire au référentiel
Récupération du référentiel des affiliations
Récupération des affiliations à partir du nom
Récupération des laboratoires
Récupération des laboratoires à partir de leurs affiliations
Récupération des laboratoires d'un auteur
Récupération des informations d'un laboratoire
Récupération des laboratoires à partir de leurs noms
Récupération des laboratoires à partir de leurs sigles
Recherche de laboratoires
Récupération des domaines scientifiques
Récupération des informations sur un domaine scientifique
Récupération des domaines scientifiques à partir du code parent
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
6
Consultation des référentiels
•
Les projets ANR
•
•
getRefANR_byCode :
getRefCodeANR :
•
Les projets européen
•
•
getRefCodeProjEurope :
getRefProjEurope_byCode :
•
Les métadonnées
•
•
getRefMetaData :
getRefMetaData_forTypePubli :
•
Les fichiers
•
•
•
getRefDateVisible :
getRefFormat :
getRefRightFulltext :
•
Le dépôt
•
•
•
getRefCollection :
getRefInstance :
getRefTypePubli :
Récupération des informations d'un projet ANR à partir d'un code
Récupération de la liste des codes ANR
Récupération de la liste des projets européens
Récupération des informations sur un projet européen
Récupération de la liste des métadonnées à renseigner lors d'un dépôt
Récupération de la liste des métadonnées à renseigner pour un type de publication
Récupération des periodes d'embargo
Récupération des formats de fichiers déposables
Récupération des droits sur un fichier
Récupération des collections d'un utilisateurs
Récupération des instances de la plateforme HAL
Récupération des types de publications
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
7
Consultation des référentiels
•
Les organismes de thèse
•
•
getRefOrgThe :
getRefOrgThe_byName :
•
Les écoles doctorales
•
•
•
getRefSchool :
getRefSchool_byName :
getRefSchool_byOrgThe :
Récupération des organismes de thèses
Récupération des organismes de thèses à partir de leurs noms
Récupération des écoles doctorales
Récupération des écoles doctorales à partir d'un nom
Récupération des écoles doctorales à partir d'un organisme de thèses
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
8
Consultation des référentiels
Recherche d’un laboratoire
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
9
Consultation des référentiels
Recherche d’un laboratoire
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
10
Consultation des référentiels
Recherche d’un laboratoire
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
11
Consultation des référentiels
Recherche d’un laboratoire
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
12
Effectuer / Modifier un dépôt
 déposer, compléter, modifier un dépôt
accessible via le protocole HTTP à l’URL :
Serveur de production :
http://hal.archives-ouvertes.fr/ws/submit.php
wsdl : http://hal.archivesouvertes.fr/ws/submit.php?wsdl
Serveur de développement / test :
http://paol.ccsd.cnrs.fr/ws/submit.php
wsdl : http://paol.ccsd.cnrs.fr/ws/submit.php?wsdl
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
13
Effectuer / Modifier un dépôt
 Chaque dépôt en texte intégral est vérifié au CCSD
 3 méthodes pour avertir les systèmes locaux de
l’évolution du dépôt (accepté, en attente de modification,
refusé) :
 Par mail (identifiant, statut, motif si modification ou refus)
 Par script HTTP méthode POST





identifiant
version
password
status
comment
 Par WebServices  hal_article_status
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
14
Effectuer / Modifier un dépôt
•
addCollection :
Tamponnage d'un article
•
addFile :
Ajout d'un fichier à une référence bibliographique
•
cross :
Ajout d'un domaine scientifique
•
jref :
Ajout / modification du type de publication d'un article
•
modify :
Correction d'un dépôt
•
putOnLine :
Mise en ligne d'un document sous embargo
•
replace :
Dépôt d'une nouvelle version
•
status :
Récupération du statut d'un dépôt
•
update :
Modification des métadonnées d'un article
•
upload :
Dépôt d'un article
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
15
Consulter / Rechercher des articles
 déposer, compléter, modifier des dépôts
accessible via le protocole HTTP à l’URL :
Serveur de production :
http://hal.archives-ouvertes.fr/ws/search.php
wsdl : http://hal.archivesouvertes.fr/ws/search.php?wsdl
Serveur de développement / test :
http://paol.ccsd.cnrs.fr/ws/search.php
wsdl : http://paol.ccsd.cnrs.fr/ws/search.php?wsdl
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
16
Consulter / Rechercher des articles
•
existOnHAL :
Recherche de l'existence d'un papier dans l'archive HAL
suivant le titre
•
getArticleCounter :
Récupération des statistiques de consultation d'un article
•
getArticleFile :
Récupération du texte intégral d'un article
•
getArticleMetadata :
Récupération des métadonnées d'un article
•
search :
Recherche dans l'archive HAL
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
17
Exemple de code
Une recherche :
http://www.ccsd.cnrs.fr/ANF2012/search.php
Un dépôt:
http://www.ccsd.cnrs.fr/ANF2012/ws_submit.php
Formation « Utilisation avancée de HAL » - ccsd – 25 septembre 2012
18