API nonspec

De conditorwi
Aller à : navigation, rechercher

Sommaire

En attendant la mise en page sur le wiki, vous pouvez accéder au document word

INTRODUCTION

L'API permet de récupérer des notices de Conditor en JSON. Elles sont constituées des champs utiles aux traitements de repérage des doublons et des futurs alignements avec le RNSR et du champ teiBlob (version XML-TEI encodée en base 64 de la notice complète).

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

La documentation complète est disponible sur github dédié à Conditor.

Vous trouverez sur cette page du wiki des exemples de requêtes pour interroger l'API et récupérer les signalements.


Logique de construction de la requête

protocole://nom de domaine/path?q="requête Lucène"&paramètres&access_token=token

où protocole://=https et nom de domaine=api.conditor.fr


Pour connaître la syntaxe de Lucène, cliquez ici.


Recommandations génériques

Penser à écrire les différentes formes qui peuvent être rencontrées et notamment la valeur complète à retrouver

Penser à échapper les doubles quotes quand une expression est à rechercher

(voir Je veux les signalements qui ont l'ORCID 0000-0002-5537-2261)


EXEMPLES de REQUÊTES

Pour avoir des détails concernant les résultats, cliquez sur F12.

X-Result-Count : xxxx nombre de signalements par page

X-Total-Count : xxxx nombre total de signalements

Par défaut 10 notices par page sont affichées.

Au-delà de 1 000, utiliser l'API Scroll (voir EXEMPLES de REQUÊTES POUR VISUALISER LES SIGNALEMENTS quand le nombre de résultats est supérieur à 1000)


Je veux tous les signalements de Conditor

https://api.conditor.fr/v1/records?q="*"&access_token=eyJhb…CigzA

X-Result-Count 10

X-Total-Count 1084798


Je veux afficher les 500 premiers signalements Conditor

https://api.conditor.fr/v1/records?q="*"&page_size=500&access_token=eyJhb…CigzA

X-Result-Count 500

X-Total-Count 1084798

Je veux afficher les 1000 premiers signalements dont la date de publication est 2014 ou 2015

https://api.conditor.fr/v1/records?q="publicationDate:(2014 OR 2015)"&page_size=1000&access_token=eyJhb…CigzA

X-Result-Count 1000

X-Total-Count 501052

Si la valeur est supérieure à 1 000, pour visualiser les résultats ou les récupérer, passer par l'API Scroll


Je veux le signalement qui a pour Id Conditor xcdV4otcYOKzKDnIlwwtoToxi

https://api.conditor.fr/v1/records?q="idConditor:xcdV4otcYOKzKDnIlwwtoToxi"&access_token=eyJhb…CigzA

(autre possibilité : https://api.conditor.fr/v1/records/xcdV4otcYOKzKDnIlwwtoToxi?&access_token=eyJhb…CigzA)


Je veux les signalements de HAL avec pour date de publication 2015

https://api.conditor.fr/v1/records?q="source:hal AND publicationDate:2015"&access_token=eyJhb…CigzA


Je veux les signalements qui comportent "montpellier" dans au moins une des adresses

https://api.conditor.fr/v1/records?q=authors>affiliations>"authors.affiliations.address:montpellier"&access_token=eyJhb…CigzA


Je veux les signalements dont l'auteur est affilié au laboratoire dont le code RNSR est 199111950H

https://api.conditor.fr/v1/records?q=authors>affiliations>"authors.affiliations.rnsr:199111950H"&access_token=eyJhb…CigzA


Je veux les signalements qui ont pour DOI 10.1109/EAEEIE.2014.6879378

https://api.conditor.fr/v1/records?q="doi:\"10.1109/EAEEIE.2014.6879378\""&access_token=eyJhb…CigzA


Je veux les signalements qui ont l'ORCID 0000-0002-5537-2261

https://api.conditor.fr/v1/records?q=authors>"authors.orcId:(\"0000-0002-5537-2261\" OR \"https://orcid.org/0000-0002-5537-2261\")"&access_token=eyJhb…CigzA&access_token=eyJhb…CigzA


Je veux les signalements provenant de HAL avec pour date de publication 2015 et dont l'auteur a pour ORCID 0000-0001-8063-5388

https://api.conditor.fr/v1/records?q="source:hal AND publicationDate:2015" authors>"authors.orcId:\"https://orcid.org/0000-0001-8063-5388\""&access_token=eyJhb…CigzA&access_token=eyJhb…CigzA


Je veux les signalements avec un doublon certain

https://api.conditor.fr/v1/records?q="isDuplicate:true"&access_token=eyJhb…CigzA&access_token=eyJhb…CigzA


Je veux les signalements avec un doublon incertain

https://api.conditor.fr/v1/records?q="isNearDuplicate:true"&access_token=eyJhb…CigzA


Pour repérer les éventuelles erreurs, appeler le mode debug

https://api.conditor.fr/v1/records?debug&q=idConditor:xcdV4otcYOKzKDnIlwwtoToxi"&access_token=eyJhb…CigzA

il manque le " entre = et idConditor


EXEMPLES DE SELECTIONS DE CHAMPS

Sans précision, toute la notice est affichée puis récupérée. Pour limiter à certains champs, il est nécessaire d'utiliser "includes" et/ou "excludes.

Je veux tous les signalements avec uniquement le champ auteur (et les sous-champs liés) et l'Id Conditor

https://api.conditor.fr/v1/records?includes=authors,idConditor&access_token=eyJhb…CigzA


Je veux tous les signalements sans le champ auteur ni ses sous-champs

https://api.conditor.fr/v1/records?excludes=authors&access_token=eyJhb…CigzA


Je veux tous les signalements avec le champ auteur et tous ses sous-champs sauf le sous-champ surname

https://api.conditor.fr/v1/records?includes=authors&excludes=authors.surname&access_token=eyJhb…CigzA


Je veux la TEI (décodée) du signalement ayant pour idConditor : dG0WlsDEZCmyKKgb2v4ZzFQWr

https://api.conditor.fr/v1/records/dG0WlsDEZCmyKKgb2v4ZzFQWr/tei?&access_token=eyJhb…CigzA


EXEMPLES DE RECUPERATION DES SIGNALEMENTS

Je veux récupérer les signalements qui ont l'ORCID 0000-0002-5537-2261

https://api.conditor.fr/v1/records/zip?q=authors>"authors.orcId:(\"0000-0002-5537-2261\" OR \"https://orcid.org/0000-0002-5537-2261\")"&access_token=eyJhb…CigzA


Je veux récupérer les signalements avec leur(s) doublon(s) certain(s)

https://api.conditor.fr/v1/records/vQFzTDqVGsMqHzRb446dEYskV/duplicates/and_self?&access_token=eyJhb…CigzA


Je veux récupérer les signalements avec leur(s) doublon(s) incertain(s)

https://api.conditor.fr/v1/records/3ZeQzUR9YK2UzW5C05DzdrddX/near_duplicates/and_self?&access_token=eyJhb…CigzA


EXEMPLES de REQUÊTES POUR VISUALISER LES SIGNALEMENTS quand le nombre de résultats est supérieur à 1000

En cours

Je veux les signalements avec un doublon certain

https://api.conditor.fr/v1/records?q="isDuplicate:true"&page_size=1000&scroll=5m&access_token=eyJhb…CigzA

X-Result-Count 1000


X-Total-Count 523171

Pour obtenir les résultats suivants, récupérer le Scroll-Id Scroll-Id :