API

De conditorwi
Aller à : navigation, rechercher

Pour interroger l'API Conditor, il est nécessaire d'avoir un token valable 3 mois. Ce token est à demander aux services de Conditor.


Installation d'un module de moissonnage

Pour plus de facilités, nous vous conseillons l'utilisation d'un module de moissonnage (co-harvester). Pour ce faire, son installation sous Linux est nécessaire. Créez un répertoire dédié puis depuis ce répertoire, lancer les différentes commandes ; ce qui donne :

En cas de problème d'installation, consultez la page dédiée sur github.

Ce module ne permet pas de visualiser les notices répondant à votre requête. Pensez donc à la tester directement sur l'API et à adapter la requête pour le moissonneur(voir plus bas Exemples de requêtes (en cours))

Modalités de moissonnage

Pour récupérer les notices de référence en json

La notice de référence est la notice pour laquelle des champs ont été retenus (ils diffèrent de ceux de la notice initiale) et pour lesquels, en cas de doublons, le contenu a été sélectionné, en fonction de la source. Vous trouverez les champs présents dans cette notice ici et les règles de sélection


Ligne de commande avec en gras ce que vous avez à modifier

node index.js --query="https://api.conditor.fr/v1/records?q=%22votreRequête%22&page_size=1000&paramètres&scroll=1m&access_token=votreToken" --source="conditor" --output="out/nomDuFichierRésultat" --reference --conf="conf/conditor.reference.json"

Pensez à lancer les lignes de commandes qui apparaitront sur votre écran à la fin de ce traitement

votreRequête: elle suit la syntaxe de l'API. Des exemples pour chaque champ seront décrits (plus bas Exemples de requêtes (en cours)). En attendant vous pouvez aller voir les anciens exemples pour les non-spécialistes ou pour les spécialistes. Attention, dans votre requête, remplacez les espaces par %20.

paramètres : voir les anciens exemples mentionnés ci-dessus.

votreToken : token valable 3 mois qui vous a été communiqué par nos services.

nomDuFichierRésultat : nom que vous souhaitez donner à votre fichier, l'extension .json sera attribuée automatiquement. Ce fichier contient toutes les notices de référence en json. Il se trouve par défaut sous le répertoire conditor/co-harvester/out. Si vous souhaitez le mettre dans un autre répertoire changer le chemin --output="out/nomDunSousRépertoire/nomDuFichierRésultat"

conditor.reference.json : ce fichier, téléchargé lorsque vous avez lancé la commande npm install, se trouve sous conditor/co-harvester/conf, mettez le token valable 3 mois qui vous a été communiqué par nos services.

Pour récupérer les notices initiales en json

La notice initiale est la notice constituée à partir de la notice tei-Conditor ; tous les champs de cette dernière n'ont pas été extraits. Voir la liste des champs Retrouvez la DTD ainsi que les feuilles de style de chaque source sous github

Attention, si vous interrogez pour récupérer les notices initiales vous aurez dans votre corpus toutes les notices doublons (si A est doublon de B vous aurez la notice A et la notice B, chacune mentionnant le fait qu'elle soit doublon de l'autre). Si vous ne souhaitez pas avoir les doublons, moissonnez Conditor pour récupérer les notices de référence.


Ligne de commande avec en gras ce que vous avez à modifier

node index.js --query="https://api.conditor.fr/v1/records?q=%22votreRequête%22&page_size=1000&paramètres&scroll=1m&access_token=votreToken" --source="conditor" --output="out/nomDuFichierRésultat"

votreRequête: elle suit la syntaxe de l'API. Des exemples pour chaque champ seront décrits (voir plus bas Exemples de requêtes (en cours)). En attendant vous pouvez aller voir les anciens exemples pour les non-spécialistes ou pour les spécialistes. Attention, dans votre requête, remplacez les espaces par %20.

paramètres : voir les anciens exemples mentionnés ci-dessus.

votreToken : token valable 3 mois qui vous a été communiqué par nos services.

nomDuFichierRésultat : nom que vous souhaitez donner à votre fichier, l'extension .json sera attribuée automatiquement. Ce fichier contient toutes les notices initiales en json. Il se trouve par défaut sous le répertoire conditor/co-harvester/out. Si vous souhaitez le mettre dans un autre répertoire changer le chemin --output="out/nomDunSousRépertoire/nomDuFichierRésultat"

Pour récupérer les notices initiales en TEI-Conditor

La notice initiale en tei-Conditor est la notice originale reformatée en tei-Conditor (format xml inspiré du tei Hal et adapté aux besoins) ; tous les champs de cette dernière n'ont pas été extraits. Voir la liste des champs Retrouvez la DTD ainsi que les feuilles de style de chaque source sous github

Attention, si vous interrogez pour récupérer les notices initiales vous aurez dans votre corpus toutes les notices doublons (si A est doublon de B vous aurez la notice A et la notice B, chacune mentionnant le fait qu'elle soit doublon de l'autre). Si vous ne souhaitez pas avoir les doublons, moissonnez Conditor pour récupérer les notices de référence mais actuellement seul le format json est proposé.

Lignes de commande avec en gras ce que vous avez à modifier

node index.js --query="https://api.conditor.fr/v1/records?q=%22votreRequête%22&page_size=1000&paramètres&scroll=1m&access_token=votreToken" --source="conditor" --output="out/nomDuFichierRésultat"

puis

node tools/extractFiles.js --input="out/nomDuFichierRésultat.json" --output="out/conditor.gz" --data="teiBlob" --id="idConditor" --archive="gz" --format=".tei"

votreRequête: elle suit la syntaxe de l'API. Des exemples pour chaque champ seront décrits (voir plus bas Exemples de requêtes (en cours)). En attendant vous pouvez aller voir les anciens exemples pour les non-spécialistes ou pour les spécialistes. Attention, dans votre requête, remplacez les espaces par %20.

paramètres : voir les anciens exemples mentionnés ci-dessus.

votreToken : token valable 3 mois qui vous a été communiqué par nos services.

nomDuFichierRésultat : nom que vous souhaitez donner à votre fichier, l'extension .json sera attribuée automatiquement. Ce fichier contient toutes les notices initiales en json. Il se trouve par défaut sous le répertoire conditor/co-harvester/out. Si vous souhaitez le mettre dans un autre répertoire changer le chemin --output="out/nomDunSousRépertoire/nomDuFichierRésultat"

Exemples de requêtes (en cours)

Champs notice initiale Champs notice de référence Requêtes API Requêtes moissonneur
abstract.en x https://api.conditor.fr/v1/records?q="abstract.en:\"Abdallah II’s foreign policy\""&access_token= node index.js --query="https://api.conditor.fr/v1/records?q=%22abstract.en:\%22Abdallah%20II’s%20foreign%20policy\%22%22&page_size=1000&scroll=1m&access_token=votreToken" --source="conditor" --output="out/conditor/conditor_test"
abstract.fr x https://api.conditor.fr/v1/records?q="abstract.fr:\"Abdallah II de Jordanie\""&access_token=
articleNumber x
arxiv x https://api.conditor.fr/v1/records?q="arxiv:1907.04532"&access_token=
authorNames x
authors.affiliations.address x https://api.conditor.fr/v1/records?q=authors>affiliations>"authors.affiliations.address:rennes"&access_token=
authors.affiliations.idRef x https://api.conditor.fr/v1/records?q=authors>affiliations>"authors.affiliations.idRef:124360114"&access_token=
authors.affiliations.isni x même logique que authors.affiliation.idRef
authors.affiliations.ref x même logique que authors.affiliation.idRef
authors.affiliations.rnsr x https://api.conditor.fr/v1/records?q=authors>affiliations>"authors.affiliations.rnsr:200715452V"&access_token=

https://api.conditor.fr/v1/recordsq="language:English AND publicationDate:(2017 OR 2016)" authors>affiliations>"authors.affiliations.rnsr:200610854B"

authors.enrichments.idHal x https://api.conditor.fr/v1/records?q=authors>enrichments>"authors.enrichments.idHal:4756"&access_token=
authors.enrichments.idRef x même logique que authors.enrichments.idHal
authors.enrichments.orcId x même logique que authors.enrichments.idHal
authors.forename x même logique que authors.surname
authors.halAuthorId x même logique que authors.idHal
authors.idHal x https://api.conditor.fr/v1/records?q=authors>"authors.idHal:4756"&access_token=
authors.idRef x même logique que authors.idHal
authors.isni x même logique que authors.idHal
authors.orcId x même logique que authors.idHal
authors.researcherId x même logique que authors.idHal
x même logique que authors.idHal
authors.surname x https://api.conditor.fr/v1/records?q=authors>"authors.surname:Kaaniche"&access_token=
authors.viaf x même logique que authors.idHal
bibCode x même logique que arxiv
cern x même logique que arxiv
classification.dewey x https://api.conditor.fr/v1/records?q="classification.dewey:616.99"&access_token=
classification.hal x https://api.conditor.fr/v1/records?q="classification.hal:\"Life Sciences [q-bio]/Human health and pathology\""&access_token=
classification.tef x même logique que classification.hal
classification.thesisDomain x même logique que classification.hal
creationDate x
defenseOrganisms.associatedLaboratory x même logique que defenseOrganisms.degreeGrantor
defenseOrganisms.associatedLaboratoryIdRef x même logique que defenseOrganisms.degreeGrantorIdRef
defenseOrganisms.degreeGrantor x https://api.conditor.fr/v1/records?q=defenseOrganisms>"defenseOrganisms.degreeGrantor:\"Université de Lorraine\""&access_token=
defenseOrganisms.degreeGrantorIdRef x https://api.conditor.fr/v1/records?q=defenseOrganisms>"defenseOrganisms.degreeGrantorIdRef:157040569"&access_token=
defenseOrganisms.doctoralSchool x même logique que defenseOrganisms.degreeGrantor
defenseOrganisms.doctoralSchoolIdRef x même logique que defenseOrganisms.degreeGrantorIdRef
documentType x https://api.conditor.fr/v1/records?q="documentType:(ART OR \"Journal Article\" OR \"Journal article\")"&access_token=

https://api.conditor.fr/v1/records?q="publicationDate:2017 AND documentType:Thèse?d?exercice" &includes=documentType,publicationDate,authors.affiliations.address&access_token=

doi x https://api.conditor.fr/v1/records?q="doi:\"10.1016/j.jqsrt.2016.04.001\""&access_token=
duplicateRules x
duplicates.idConditor x même logique que duplicates.sessionName
duplicates.isValidatedByUser x
duplicates.rules x https://api.conditor.fr/v1/records?q=duplicates>"duplicates.rules:\"Ouvrage : 1ID:isbn+TiC\""&access_token=
duplicates.sessionName x https://api.conditor.fr/v1/records?q=duplicates>"duplicates.sessionName:HAL*"&access_token=
duplicates.source x même logique que duplicates.sessionName
duplicates.sourceUid x même logique que duplicates.sessionName
editor.forename x même logique que authors.surname
editor.idRef x même logique que authors.idHal
editor.surname x même logique que authors.surname
eisbn x https://api.conditor.fr/v1/records?q="eisbn:\"978-3-319-48787-8\""&access_token=
eissn x même logique que eisbn
electronicPublicationDate x https://api.conditor.fr/v1/records?q="electronicPublicationDate:2015"&access_token=
enrichments.classifications.bso x
enrichments.classifications.scienceMetrix.level x
enrichments.classifications.scienceMetrix.value x https://api.conditor.fr/v1/records?q=enrichments.classifications.scopus>"enrichments.classifications.scopus.value:Earth*"&access_token=
enrichments.classifications.scopus.level x
enrichments.classifications.scopus.value x même logique que enrichments.classifications.scienceMetrix.value
enrichments.oa.core x https://api.conditor.fr/v1/records?q="enrichments.oa.core:*"&access_token=
enrichments.oa.unpaywall x même logique que enrichments.oa.core
ensam x https://api.conditor.fr/v1/records?q="ensam:\"http://hdl.handle.net/10985/10279\""&access_token=
first3AuthorNames
first3AuthorNamesWithInitials
fulltextPath x
funders.grantNumber x même logique que authors.idHal
funders.name x même logique que authors.surname

Visualisation des notices dans Lodex (à venir)