17 décembre 2024

API Stylo

Les API GraphQl, à la différence des API Rest, ne proposent qu’un seul endpoint. C’est la requête qui permet de trier les données récupérées. Le endpoint de l’API Stylo est le suivant https://stylo.huma-num.fr/graphql.

Avec l’APi Stylo, on ne travaille qu’avec des requêtes POST (limitation à 2000 char avec les requêtes GET).

On peut passer deux types de requêtes, des query (en lecture seule) ou des mutation qui permettent de modifier des ressources.

Les API GraphQL embarquent une documentation. Les résultats sont récupérés au format JSON.

Dans Stylo, l’unité éditoriale avec laquelle on souhaite travailler c’est d’abord l’article, de fait ce sont les articles qui rassemblent les métadonnées.

Les corpus sont rattachés à la notion d’espaces, qu’ils soient partagés ou de travail, avec l’API il est donc possible de de filtrer les corpus au regard du workspace auquel ils appartiennent. L’ordre des articles est celui défini dans le client (attribut order).