HAL - Contributions de l’utilisateur [fr]

CasuHAL AtelierAPI

2018-06-26T12:55:47Z

Halscdorleans : /* Introduction */

== 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 que nous allons compléter avec des détails et exemples.

== Introduction ==

=== 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

== 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

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

'''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'''

http://api.archives-ouvertes.fr/search/?q=collCode_s:%22INRIA%22%20AND%20producedDateY_i:2015&rows=0&wt=xml&indent=true&facet=true&facet.pivot=title_s,docType_s,halId_s&facet.limit=10&facet.mincount=2

'''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)

CasuHAL AtelierAPI

2018-05-04T14:49:27Z

Halscdorleans : /* Sword */

== Notes libres pour l'atelier API des journées CasuHAL 2018 ==

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

=== Sword ===
*L'API de dépôt SWORD permet l'import automatique de documents dans l'archive ouverte HAL.
*Comprendre qu'il s'agit d'une sorte de module permettant d'entrer des données dans HAL (comme on entre une donnée par le biais du formulaire de dépôt *manuel sur le site web HAL)
*Pour entrer des données il faut respecter d'emblée un ensemble de contraintes. Type format TEI des notices (https://hal.archives-ouvertes.fr/documents/aofr.xsd). Type archive ZIP
*Formulaire en ligne possible pour envoyer ses données : https://api.archives-ouvertes.fr/sword/upload/

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"
*On interroge la base : interroger l'API ne résout pas les problèmes de qualités des données.

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:41:17Z

Halscdorleans : /* Sword */

== Notes libres pour l'atelier API des journées CasuHAL 2018 ==

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

=== Sword ===
*L'API de dépôt SWORD permet l'import automatique de documents dans l'archive ouverte HAL.
*Comprendre qu'il s'agit d'une sorte de module permettant d'entrer des données dans HAL (comme on entre une donnée par le biais du formulaire de dépôt *manuel sur le site web HAL)

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"
*On interroge la base : interroger l'API ne résout pas les problèmes de qualités des données.

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:41:06Z

Halscdorleans : /* Eléments de langage */

== Notes libres pour l'atelier API des journées CasuHAL 2018 ==

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

=== Sword ===
L'API de dépôt SWORD permet l'import automatique de documents dans l'archive ouverte HAL.
*Comprendre qu'il s'agit d'une sorte de module permettant d'entrer des données dans HAL (comme on entre une donnée par le biais du formulaire de dépôt *manuel sur le site web HAL)

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"
*On interroge la base : interroger l'API ne résout pas les problèmes de qualités des données.

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:36:11Z

Halscdorleans : /* Utiliser l'API ? */

== Notes libres pour l'atelier API des journées CasuHAL 2018 ==

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"
*On interroge la base : interroger l'API ne résout pas les problèmes de qualités des données.

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:33:34Z

Halscdorleans : /* Support libre pour l'atelier API des journées CasuHAL 2018 */

== Notes libres pour l'atelier API des journées CasuHAL 2018 ==

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:32:54Z

Halscdorleans : /* Eléments de langage */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Des API partout : Isidore, Istex, Sudoc Abes.

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:32:34Z

Halscdorleans : /* Utiliser l'API ? */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Utilisation de l'API : de mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin)

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin
*Donc : notion de "besoin à exprimer"

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:32:03Z

Halscdorleans : /* Démos */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Utilisation de l'API : de mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin)

== Utiliser l'API ? ==
*Cadrage : De mon point de vue mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:30:45Z

Halscdorleans : /* Eléments de langage */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql
*Utilisation de l'API : de mon point de vue c'est si les autres moyens d'accès ne "suffisent" pas au besoin exprimé (pour les stats = ne pas oublier le module stats dans l'admin)

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:25:16Z

Halscdorleans : /* Eléments de language */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:16:49Z

Halscdorleans : /* Un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

=== Les types de champs ===
https://api.archives-ouvertes.fr/docs/search/schema/field-types/#field-types

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:15:35Z

Halscdorleans : /* Un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.
//
*pagination : afficher 50 après les 50 1ers : start=50&rows=50
*Curseurs : si vous devez parcourir plusieurs milliers de résultats, pour des raisons de performance il est fortement recommandé d'utiliser les curseurs
//
*Les facettes sont des listes de termes extraits en fonction d'une requête.
*On peut les utiliser pour avoir une liste de valeurs distinctes sur un champ donné.
*Pour générer des facettes, il faut ajouter le paramètre facet=true à une requête.
*Il faut ensuite ajouter les champs avec lesquel construire les facettes avec le paramètre facet.field=NomDuChamp à une requête.
*facet.sort=index, count, prefix, contains (facet.contains.ignoreCase=true)
*Pivots
*plage de résultats
//
*Vous pouvez obtenir vos résultats de requêtes groupés selon un critère de votre choix, à condition que le critère soit représenté par un champ non multivalué et de type string.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:10:02Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== Un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:09:43Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates
//
*Le nombre de réponses à retourner est définit par le paramètre rows .
*Le nombre total de dépôt/notices ne change pas avec ce paramètres, seul le nombre de résultats effectivement retournés varie.
*Par défaut les requêtes ne retournent que les 30 premiers résultats, le maximum autorisé est 10000. Si vous souhaitez plus de résultats vous devez utiliser la pagination.
*Le paramètre &rows=0 peut permettre de ne retourner que le nombre de résultats et d'enlever les documents du corps de la réponse. Vous pouvez par exemple utiliser ce paramètre à des fins de statistiques ou si vous voulez retourner uniquement des facettes.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:08:49Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = * + doc pour les spécificités des calculs de dates

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T14:08:08Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de language ==
*C’est un accès aux données.
*C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
*C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
*C’est enrichir son site avec des données
*API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. (exemple Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central.)
*Les portails HAL sont une façon d'accéder au réservoir de données qu’est HAL
*l'API donne accès à la base de données : c'est donc logiquement l'accès le plus complet possible (contrairement au site web qui ne permet à l'usager de ne faire que ce qui a été prévu)
*Pour utiliser une API il faut connaître la structure des données, c’est pour ça qu’elles sont toujours accompagnées d’une documentation
*Les formats de données = Json (Utile d'installer Json view dans son navigateur)
*Sparql Endpoint : https://api.archives-ouvertes.fr/sparql

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*
//
*Par défaut, les résultats sont triés par pertinence.
*Le tri des résultats peut se faire sur n'importe quel champ en évitant les champs de type text (suffixe "_t") et les champs multi-valués qui donneront des résultats imprévisibles.
*Le paramètre pour choisir les champs à retourner est sort + le sens de tri asc ou desc
//
*Le paramètre pour ajouter des filtres est fq suivi de la requête servant au filtre : fq=submitType_s:file
*Il est possible de faire des requêtes sur des intervalles avec cette syntaxe champ:[valeurDébut TO valeurFin]
*valeur maximale = *

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T13:50:23Z

Halscdorleans : /* Eléments de langage */

CasuHAL AtelierAPI

2018-05-04T13:49:57Z

Halscdorleans : /* Eléments de langage */

CasuHAL AtelierAPI

2018-05-04T13:46:09Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.
//
*Par défaut seuls les champs docid et label_s sont retournés dans une réponse. Cependant tous les champs stockés peuvent être retournés dans le format de réponse
*Le paramètre pour choisir les champs à retourner est fl. Les champs demandés doivent être séparés par le signe ,
*Formats de sortie avec fl = JSON, XML et CSV uniquement
*On peut utiliser le caractère * comme troncature de nom de champ, eg fl=cha*

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T13:44:24Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
//
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T13:44:10Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité
==
*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T13:43:57Z

Halscdorleans : /* un peu de compulsion de la doc */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== Eléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== Démos ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

URL d'entrée

+

critère : ?q=valeur OU ?q=champ:valeur / Séparateur &

+

filtre : fq=champ:valeur / séparateur &

+

retour : fl=champ / séparateur ,

les filtres sont sur des listes fermées :

== un peu de compulsion de la doc ==

*Il faut au moins un paramètre dans l'URL pour faire une requête, ce paramètre est q
*Ce paramètre contient la requête à effectuer.
*Le paramètre doit être suivi du nom du champ dans lequel rechercher puis de la valeur à chercher.
*Si le nom du champ dans lequel chercher est omis, par défaut la recherche porte sur l'index text qui contient les valeurs de plusieurs champs.
*Pour chercher dans un champ particulier la syntaxe est champ:terme
*Pour chercher plusieurs champs, utiliser (terme1 terme2). L'opérateur booléen par défaut est AND
*Pour OR : Utiliser (terme1 OR terme2)
*Pour une phrase : Utiliser les guillemets doubles "phrase"
*Troncature ? * ~ proximité

*Le format de réponse par défaut est JSON
*Le format de réponse est spécifié par le paramètre wt : wt=json
*liste des formats dans la doc. Ajouter indent=true pour indenter le format de réponse.

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T13:38:31Z

Halscdorleans : /* un peu de compulsion de la doc */

CasuHAL AtelierAPI

2018-05-04T13:38:15Z

Halscdorleans : /* un peu de compulsion de la doc */

CasuHAL AtelierAPI

2018-05-04T13:37:14Z

Halscdorleans : /* un peu de compulsion de la doc */

CasuHAL AtelierAPI

2018-05-04T13:36:23Z

Halscdorleans : /* Déconstruction de requêtes */

CasuHAL AtelierAPI

2018-05-04T13:21:40Z

Halscdorleans : /* Déconstruction de requêtes */

CasuHAL AtelierAPI

2018-05-04T13:21:22Z

Halscdorleans :

CasuHAL AtelierAPI

2018-05-04T12:46:53Z

Halscdorleans :

CasuHAL AtelierAPI

2018-05-04T12:46:28Z

Halscdorleans :

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== 5 minutes d'éléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== 5 minutes de démo ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

== un peu de compulsion de la doc ==

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T12:46:04Z

Halscdorleans :

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== 5 minutes d'éléments de langage ==
C’est un accès aux données.
C’est une source de donnée qui est exposée de manière à être re-exploitée par des tiers.
C’est prendre la main sur les données afin de les organiser et les agencer autrement que sur l’interface standard.
C’est enrichir son site avec des données
API ou Webservices qui permettent d'extraire ou d'afficher une information du catalogue à partir d'une URL contenant des critères de recherche. Le Sudoc met diverses API à la disposition des systèmes locaux pour intégrer à la volée aux fonctions locales des données du système central8.

== Discussion ==

== 5 minutes de démo ==
Isidore
Istex
Sudoc Abes

== Déconstruction de requêtes ==

== un peu de compulsion de la doc ==

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T12:36:47Z

Halscdorleans : /* recherche de publis */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[* TO NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

NumFound = <result name="response" numFound="146" start="0">

CasuHAL AtelierAPI

2018-05-04T12:36:08Z

Halscdorleans : /* recherche de publis */

CasuHAL AtelierAPI

2018-05-04T12:34:49Z

Halscdorleans : /* Support libre pour l'atelier API journées CasuHAL 2018 */

== Support libre pour l'atelier API des journées CasuHAL 2018 ==

''' Hélène Jouguet '''

== recherche de publis ==
https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[*%20TO%20NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche : ?fq puis &fl puis rows et enfin wt

labstructid = polen (univ orleans)

date : * to now

CasuHAL AtelierAPI

2018-05-04T12:28:38Z

Halscdorleans : Page créée avec « == Support libre pour l'atelier API journées CasuHAL 2018 == ''' Hélène Jouguet ''' https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_... »

== Support libre pour l'atelier API journées CasuHAL 2018 ==

''' Hélène Jouguet '''

https://api.archives-ouvertes.fr/search/?fq=labStructId_i:186732&fq=submittedDate_tdate:[*%20TO%20NOW]&fq=docType_s:ART&fl=halId_s&fl=docid&fl=contributorFullName_s&fl=title_s&fl=language_s&fl=docType_s&fl=submittedDate_s&fl=producedDateY_i&fl=journalTitle_s&fl=issue_s&fl=volume_s&fl=page_s&fl=doiId_s&fl=audience_s&fl=comment_s&fl=authLastNameFirstName_s&fl=rteamStructAcronym_s&fl=authId_i&fl=abstract_s&rows=200&wt=xml

requête de recherche
labstructid = polen (univ orleans)
date : * to now