Chers utilisatrices et utilisateurs,
Nous venons tout juste de mettre en ligne la version 3.10.0 de l’API ISTEX, qui apporte un certain nombre de nouveautés et de résolutions de bugs.
Une nouvelle documentation
La nouveauté la plus visible est la nouvelle documentation. Celle-ci se veut plus claire, plus agréable à lire et la plus complète possible. Un très grand nombre d’exemples a été ajouté, ce qui permet de couvrir la grande majorité des cas d’usage.
Les plus curieux d’entre vous constateront que cette documentation est réalisée avec l’utilitaire « mkdocs » et le thème graphique « readTheDocs ».
Un nouveau mode d’authentification
Une première étape dans l’intégration du mécanisme de fédération d’identités de Renater a été franchie.
Il est à présent possible pour tout membre de l’ESR de se créer et d’utiliser un « token d’identification », utilisable sur l’API ISTEX. Il suffit pour cela de se rendre à l’URL https://api.istex.fr/token/ et de s’authentifier auprès de son fournisseur d’identités (ex : Janus pour le CNRS). Pour plus d’informations, rendez-vous sur la page dédiée de la documentation.
Vous noterez que ce « token » n’est pas destiné à être directement utilisé pour un usage purement documentaire. Il est surtout utile pour ceux qui souhaitent scripter / automatiser les requêtes à l’API (pour la constitution de sous-corpus, par exemple).
La possibilité de s’authentifier simplement par fédération d’identités depuis n’importe quelle interface est en cours de développement et sera accessible très prochainement.
Du nouveau sous le capot
Un certain nombre de modifications invisibles pour l’utilisateur ont été réalisées. Celles-ci ayant trait au mécanisme de filtrage des accès, il est possible (même si peu probable) que des effets de bord apparaissent.
Si vous constatez que certains accès vous sont refusés (erreurs 401) alors que ce n’était pas le cas avant aujourd’hui, merci de nous remonter vos problèmes à l’adresse mail api-bug@listes.istex.fr.
Des bugs résolus
- Les facettes de type « histogramme » sont à présent plus souples, il est possible de les découper selon des intervalles personnalisés, grâce aux syntaxes « x[y-z:inter] » ou « x[inter] ». Plus de détails sont disponibles sur la documentation.
- À cause de soucis de performance, le nombre de documents exportables simultanément a été limité à 10 000, en attendant de trouver une solution technique.
- Dans la réponse JSON, le champ « keyCount », qui était absent de certaines facettes a été rétabli.
- L’affichage brut des messages d’erreur est à présent correctement géré et a été remplacé par un message plus parlant pour l’utilisateur.
Pour toute remarque sur cette nouvelle version, contactez api-users@listes.istex.fr, et en cas de soucis technique api-bug@listes.istex.fr.
Bonne soirée, et bonne utilisation de l’API !
Claude, pour l’équipe ISTEX-API.
Besoin d'aide ?
Consultez notre Faq, la documentation Istex ou nos tutoriels
N’hésitez pas à nous contacter si besoin, nous reviendrons rapidement vers vous !
Écrivez-nous
