Utiliser les WebServices

1. Utiliser les WebServices Estelle.Theveniaud@ccsd.cnrs.fr

2. 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

3. 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 3

4. 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‐tech@ccsd.cnrs.fr) d’activer ce compte pour l’utilisation des WS • Passer du serveur de développement au serveur de production 4

5. 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.phpwsdl: http://hal.archives-ouvertes.fr/ws/ref.php?wsdl • Serveur de développement / test : http://paol.ccsd.cnrs.fr/ws/ref.phpwsdl: http://paol.ccsd.cnrs.fr/ws/ref.php?wsdl 5

6. Consultation des référentiels • Les laboratoires • addRefLab: Ajout d'un laboratoire au référentiel • getRefAffi : Récupération du référentiel des affiliations • getRefAffi_byName : Récupération des affiliations à partir du nom • getRefLab : Récupération des laboratoires • getRefLab_byAffi : Récupération des laboratoires à partir de leurs affiliations • getRefLab_byAuthor : Récupération des laboratoires d'un auteur • getRefLab_byId : Récupération des informations d'un laboratoire • getRefLab_byName : Récupération des laboratoires à partir de leurs noms • getRefLab_byShortName : Récupération des laboratoires à partir de leurs sigles • getRefLab_search : Recherche de laboratoires • 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 : Récupération des domaines scientifiques • getRefSubject_byCode : Récupération des informations sur un domaine scientifique • getRefSubject_byCodeParent : Récupération des domaines scientifiques à partir du code parent 6

7. Consultation des référentiels • Les projets ANR • getRefANR_byCode: Récupération des informations d'un projet ANR à partir d'un code • getRefCodeANR : Récupération de la liste des codes ANR • Les projets européen • getRefCodeProjEurope : Récupération de la liste des projets européens • getRefProjEurope_byCode : Récupération des informations sur un projet européen • Les métadonnées • getRefMetaData : Récupération de la liste des métadonnées à renseigner lors d'un dépôt • getRefMetaData_forTypePubli : Récupération de la liste des métadonnées à renseigner pour un type de publication • Les fichiers • getRefDateVisible : Récupération des periodes d'embargo • getRefFormat : Récupération des formats de fichiers déposables • getRefRightFulltext : Récupération des droits sur un fichier • Le dépôt • getRefCollection : Récupération des collections d'un utilisateurs • getRefInstance : Récupération des instances de la plateforme HAL • getRefTypePubli : Récupération des types de publications 7

8. Consultation des référentiels • Les organismes de thèse • getRefOrgThe : Récupération des organismes de thèses • getRefOrgThe_byName : Récupération des organismes de thèses à partir de leurs noms • Les écoles doctorales • getRefSchool : Récupération des écoles doctorales • getRefSchool_byName : Récupération des écoles doctorales à partir d'un nom • getRefSchool_byOrgThe : Récupération des écoles doctorales à partir d'un organisme de thèses 8

9. Consultation des référentielsRecherche d’un laboratoire 9

10. Consultation des référentielsRecherche d’un laboratoire 10

11. Consultation des référentielsRecherche d’un laboratoire 11

12. Consultation des référentielsRecherche d’un laboratoire 12

13. 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.phpwsdl: http://hal.archives-ouvertes.fr/ws/submit.php?wsdl • Serveur de développement / test : http://paol.ccsd.cnrs.fr/ws/submit.phpwsdl: http://paol.ccsd.cnrs.fr/ws/submit.php?wsdl 13

14. 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 14

15. 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 15

16. 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.phpwsdl: http://hal.archives-ouvertes.fr/ws/search.php?wsdl • Serveur de développement / test : http://paol.ccsd.cnrs.fr/ws/search.phpwsdl: http://paol.ccsd.cnrs.fr/ws/search.php?wsdl 16

17. 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 17

18. 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 18