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

1. API DE HAL
1. Les API de recherche HAL
2. Référentiels
3. Documents
Raphaël Tournoy

3. TYPES D’API DISPONIBLES https://api.archives-ouvertes.fr/

4. API de recherche

5. •
•
•
•
•
•
•
•
•
•
•
•
API - RECHERCHE : CONTENUS DISPONIBLES

6. PRÉ-REQUIS TECHNIQUES

7. API des référentiels

8. LES RÉFÉRENTIELS https://api.archives-ouvertes.fr/docs/ref

9. QUELS TYPES DE RÉFÉRENTIELS ?

10. …
RECHERCHE

11. Référentiels
Exemples d’utilisation

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

13. DOCTYPE : TYPES DE DOCUMENTS
Exemple : Types de document acceptés sur TEL ( instance_s=tel )
Format JSON

14. METADATA : MÉTADONNÉES PAR TYPE DE DOCUMENT
instance_s=univ-lorraine
portail : Université de
Lorraine)
docType_s=ART

15. METADATALIST : MÉTADONNÉES DE TYPE LISTE FERMÉE
Métadonnée audience = 3 valeurs possibles

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

17. Référentiels
Types complexes

18. TYPES COMPLEXES
AUTEURS ; STRUCTURES ; DOMAINES ; REVUES ; PROJETS ANR ; PROJETS EUROPÉENS
Consultation publique HTML : https://aurehal.archives-ouvertes.fr/

19. EXEMPLE STRUCTURE DANS AURÉHAL

20. API STRUCTURE : EXEMPLE AU FORMAT JSON

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

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

23. API Documents de HAL

24. CONTENU API DOCUMENTS HAL

25. CONTENU API DOCUMENTS HAL

27. API RECHERCHE – TYPES DE CHAMPS

28. API RECHERCHE – EXEMPLES DE CHAMPS

29. API RECHERCHE - REQUÊTES

30. API RECHERCHE - REQUÊTES

31. API RECHERCHE - REQUÊTES

32. PRINCIPAUX PARAMÈTRES

33. API - construire une requête

34. API REQUÊTES / PARAMÈTRE WT = FORMAT
DE RÉPONSE (WT=FORMAT)
https://api.archives-ouvertes.fr/search/?wt=xml

35. API REQUÊTES / PARAMÈTRE Q = CRITÈRE DE
RECHERCHE (Q=TERME)
https://api.archives-ouvertes.fr/search/?q=api

36. API REQUÊTES / PARAMÈTRE Q POUR
CHERCHER DANS UN CHAMP (CHAMP:VALEUR)
https://api.archives-ouvertes.fr/search/?q=title_t:api

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

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

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

40. Construire une requête -
Facettes

41. API REQUÊTES / FACETTES : FACET=TRUE &
FACET.FIELD=CHAMP
/search/?q=*:*&rows=0&wt=xml&facet=true&facet.field=docType_s

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

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