Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Les API de HAL

446 views

Published on

Présenté lors de la journée organisée par le réseau Aramis, Villeurbanne, 30 mars 2017 : API HAL et retours d'expérience de développement

Published in: Software
  • Be the first to comment

  • Be the first to like this

Les API de HAL

  1. 1. API DE HAL 1. Les API de recherche HAL 2. Référentiels 3. Documents Raphaël Tournoy
  2. 2. TYPES D’API DISPONIBLES https://api.archives-ouvertes.fr/
  3. 3. API de recherche
  4. 4. • • • • • • • • • • • • API - RECHERCHE : CONTENUS DISPONIBLES
  5. 5. PRÉ-REQUIS TECHNIQUES
  6. 6. API des référentiels
  7. 7. LES RÉFÉRENTIELS https://api.archives-ouvertes.fr/docs/ref
  8. 8. QUELS TYPES DE RÉFÉRENTIELS ?
  9. 9. … RECHERCHE
  10. 10. Référentiels Exemples d’utilisation
  11. 11. INSTANCE : LES PORTAILS Comment obtenir la liste des portails de HAL où déposer ? https://api.archives-ouvertes.fr/r ef/doctype/?wt=json Format JSON /?wt=json
  12. 12. DOCTYPE : TYPES DE DOCUMENTS Exemple : Types de document acceptés sur TEL ( instance_s=tel ) Format JSON
  13. 13. METADATA : MÉTADONNÉES PAR TYPE DE DOCUMENT instance_s=univ-lorraine portail : Université de Lorraine) docType_s=ART
  14. 14. METADATALIST : MÉTADONNÉES DE TYPE LISTE FERMÉE Métadonnée audience = 3 valeurs possibles
  15. 15. METADATALIST : LISTE DES MÉTADONNÉES DE TYPE LISTE FERMÉE Quelles sont les valeurs acceptées pour la métadonnée AUDIENCE ? https://api.archives-ouvertes.fr/ref/metadatalist/?q=metaName_s:audience
  16. 16. Référentiels Types complexes
  17. 17. TYPES COMPLEXES AUTEURS ; STRUCTURES ; DOMAINES ; REVUES ; PROJETS ANR ; PROJETS EUROPÉENS Consultation publique HTML : https://aurehal.archives-ouvertes.fr/
  18. 18. EXEMPLE STRUCTURE DANS AURÉHAL
  19. 19. API STRUCTURE : EXEMPLE AU FORMAT JSON
  20. 20. CHAQUE RÉFÉRENTIEL A SES PROPRES CHAMPS https://api.archives-ouvertes.fr/docs/ref/resource/journal/schema/fields/#fields Exemple : Référentiel des revues
  21. 21. EXEMPLE RECHERCHE : RÉFÉRENTIEL REVUES https://api.archives-ouvertes.fr/ref/journal/?wt=json&q=publisher_t:(Elsevier)&fq=valid_s:VALID&fq=sherpaColor_s:green& fl=title_s,publisher_s,sherpaColor_s,valid_s&sort=title_s asc wt=json format de retour JSON q=publisher_t:(Elsevier) revues dont l’éditeur est elsevier &fq=valid_s:VALID limiter aux revues validées fq=sherpaColor_s:green uniquement les couleurs “green” dans SHERPA &fl=title_s,publisher_s,sherpaC olor_s,valid_s champs à afficher dans la réponse &sort=title_s asc trier les résultats par titre Revues avec le statut ‘green’ dans Sherpa où l’éditeur est Elsevier et la revue est validée dans le référentiel
  22. 22. API Documents de HAL
  23. 23. CONTENU API DOCUMENTS HAL
  24. 24. CONTENU API DOCUMENTS HAL
  25. 25. API RECHERCHE – TYPES DE CHAMPS
  26. 26. API RECHERCHE – EXEMPLES DE CHAMPS
  27. 27. API RECHERCHE - REQUÊTES
  28. 28. API RECHERCHE - REQUÊTES
  29. 29. API RECHERCHE - REQUÊTES
  30. 30. PRINCIPAUX PARAMÈTRES
  31. 31. API - construire une requête
  32. 32. API REQUÊTES / PARAMÈTRE WT = FORMAT DE RÉPONSE (WT=FORMAT) https://api.archives-ouvertes.fr/search/?wt=xml
  33. 33. API REQUÊTES / PARAMÈTRE Q = CRITÈRE DE RECHERCHE (Q=TERME) https://api.archives-ouvertes.fr/search/?q=api
  34. 34. API REQUÊTES / PARAMÈTRE Q POUR CHERCHER DANS UN CHAMP (CHAMP:VALEUR) https://api.archives-ouvertes.fr/search/?q=title_t:api
  35. 35. API REQUÊTES / PARAMÈTRE FQ FILTRER AVEC UN CHAMP (CHAMP:VALEUR) https://api.archives-ouvertes.fr/search/?q=title_t:api&fq=submitType_s:file&wt=xml
  36. 36. API REQUÊTES / PARAMÈTRE FL LISTE DE CHAMPS À RETOURNER (FL=CHAMP1,CHAMP2) https://api.archives-ouvertes.fr/search/?wt=xml&fl=*tdate,title_s
  37. 37. API REQUÊTES / PARAMÈTRE SORT POUR TRIER (SORT=CHAMP1,CHAMP2) (ASC|DESC) /search/?wt=xml&fl=submittedDate_tdate,title_s&sort=submittedDate_tdate desc
  38. 38. Construire une requête - Facettes
  39. 39. API REQUÊTES / FACETTES : FACET=TRUE & FACET.FIELD=CHAMP /search/?q=*:*&rows=0&wt=xml&facet=true&facet.field=docType_s
  40. 40. API REQUÊTES / FACETTES PIVOT : FACET=TRUE & FACET.PIVOT=CHAMP1,CHAMP2 /search/?q=*:*&rows=0&wt=xml&indent=true&facet=true&facet.pivot=docType_s,submitType_s
  41. 41. API REQUÊTES / FACETTES PLAGE : FACET=TRUE & FACET.RANGE=CHAMP search/?q=*:*&rows=0&wt=xml&indent=true&facet=true&facet.range=submittedDateY_i&facet.range.start=19 90&facet.range.end=2010&facet.range.gap=2

×